diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.json b/descriptions-next/api.github.com/api.github.com.2022-11-28.json index 9e01ccbc39..2974636fc7 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.json @@ -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": [ @@ -6372,6 +6376,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", @@ -14117,7 +14768,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" ], @@ -17916,7 +18567,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" ], @@ -22806,6 +23457,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", @@ -29078,6 +29921,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", @@ -49393,6 +50542,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", @@ -102675,6 +104138,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.", @@ -102970,6 +104457,9 @@ }, "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" + }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" } }, "required": [ @@ -105648,6 +107138,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" + } + } + }, "dependabot-repository-access-details": { "title": "Dependabot Repository Access Details", "description": "Information about repositories that Dependabot is able to access in an organization", @@ -113467,6 +115075,111 @@ } ] }, + "secret-scanning-row-version": { + "type": [ + "string", + "null" + ], + "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." + }, + "secret-scanning-pattern-override": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern." + }, + "custom_pattern_version": { + "type": [ + "string", + "null" + ], + "description": "The version of this pattern if it's a custom pattern." + }, + "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", + "null" + ], + "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", + null + ] + }, + "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", @@ -131981,6 +133694,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "type": "string" }, @@ -138881,6 +140597,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", @@ -140320,6 +142039,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", @@ -141921,6 +143643,83 @@ "updated_at" ] }, + "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", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "status": { + "type": [ + "string", + "null" + ], + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + "start_date": { + "type": "string", + "format": "date", + "examples": [ + "2022-04-28" + ] + }, + "target_date": { + "type": "string", + "format": "date", + "examples": [ + "2022-04-28" + ] + }, + "body": { + "description": "Body of the status update", + "type": [ + "string", + "null" + ], + "examples": [ + "The project is off to a great start!" + ] + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ] + }, "projects-v2": { "title": "Projects v2 Project", "description": "A projects v2 project", @@ -142002,6 +143801,27 @@ "$ref": "#/components/schemas/simple-user" } ] + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "latest_status_update": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/projects-v2-status-update" + } + ] + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" } }, "required": [ @@ -142170,83 +143990,6 @@ "title" ] }, - "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", - "examples": [ - "2022-04-28T12:00:00Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2022-04-28T12:00:00Z" - ] - }, - "status": { - "type": [ - "string", - "null" - ], - "enum": [ - "INACTIVE", - "ON_TRACK", - "AT_RISK", - "OFF_TRACK", - "COMPLETE", - null - ] - }, - "start_date": { - "type": "string", - "format": "date", - "examples": [ - "2022-04-28" - ] - }, - "target_date": { - "type": "string", - "format": "date", - "examples": [ - "2022-04-28" - ] - }, - "body": { - "description": "Body of the status update", - "type": [ - "string", - "null" - ], - "examples": [ - "The project is off to a great start!" - ] - } - }, - "required": [ - "id", - "node_id", - "created_at", - "updated_at" - ] - }, "webhooks_number": { "description": "The pull request number.", "type": "integer" @@ -164480,6 +166223,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", @@ -166118,6 +167864,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", @@ -167765,6 +169514,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", @@ -169654,6 +171406,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", @@ -171152,6 +172907,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", @@ -172454,6 +174212,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", @@ -173747,6 +175508,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", @@ -175033,6 +176797,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", @@ -176347,6 +178114,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", @@ -177625,6 +179395,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", @@ -178884,6 +180657,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", @@ -180754,6 +182530,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", @@ -182095,6 +183874,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", @@ -183348,6 +185130,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", @@ -185420,6 +187205,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", @@ -284069,6 +285857,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", @@ -284389,136 +286320,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, @@ -289377,6 +291178,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": [ { @@ -310884,6 +312720,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.", @@ -310929,15 +312774,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-next/api.github.com/api.github.com.2022-11-28.yaml b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml index 4f706a82fd..785d0304ff 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml @@ -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: @@ -4500,6 +4502,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 @@ -10308,7 +10762,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: @@ -13028,7 +13482,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. @@ -16567,6 +17021,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 @@ -21155,6 +21740,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 @@ -36109,6 +36903,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 @@ -74452,6 +75477,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 @@ -74651,6 +75693,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 @@ -76574,6 +77618,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 dependabot-repository-access-details: title: Dependabot Repository Access Details description: Information about repositories that Dependabot is able to access @@ -82474,6 +83613,93 @@ components: state: type: object description: The state of the ruleset version + secret-scanning-row-version: + type: + - string + - 'null' + 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. + secret-scanning-pattern-override: + type: object + properties: + token_type: + type: string + description: The ID of the pattern. + custom_pattern_version: + type: + - string + - 'null' + description: The version of this pattern if it's a custom pattern. + 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 + - 'null' + 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 + - + 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. @@ -95631,6 +96857,8 @@ components: - 'null' sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: type: string state_reason: @@ -100735,6 +101963,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 @@ -101805,6 +103035,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 @@ -102997,6 +104229,62 @@ components: - name - created_at - updated_at + 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 + examples: + - '2022-04-28T12:00:00Z' + updated_at: + type: string + format: date-time + examples: + - '2022-04-28T12:00:00Z' + status: + type: + - string + - 'null' + enum: + - INACTIVE + - ON_TRACK + - AT_RISK + - OFF_TRACK + - COMPLETE + - + start_date: + type: string + format: date + examples: + - '2022-04-28' + target_date: + type: string + format: date + examples: + - '2022-04-28' + body: + description: Body of the status update + type: + - string + - 'null' + examples: + - The project is off to a great start! + required: + - id + - node_id + - created_at + - updated_at projects-v2: title: Projects v2 Project description: A projects v2 project @@ -103052,6 +104340,18 @@ components: anyOf: - type: 'null' - "$ref": "#/components/schemas/simple-user" + state: + type: string + enum: + - open + - closed + latest_status_update: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/projects-v2-status-update" + is_template: + type: boolean + description: Whether this project is a template required: - id - node_id @@ -103172,62 +104472,6 @@ components: required: - id - title - 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 - examples: - - '2022-04-28T12:00:00Z' - updated_at: - type: string - format: date-time - examples: - - '2022-04-28T12:00:00Z' - status: - type: - - string - - 'null' - enum: - - INACTIVE - - ON_TRACK - - AT_RISK - - OFF_TRACK - - COMPLETE - - - start_date: - type: string - format: date - examples: - - '2022-04-28' - target_date: - type: string - format: date - examples: - - '2022-04-28' - body: - description: Body of the status update - type: - - string - - 'null' - examples: - - The project is off to a great start! - required: - - id - - node_id - - created_at - - updated_at webhooks_number: description: The pull request number. type: integer @@ -119492,6 +120736,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 @@ -120693,6 +121939,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 @@ -121901,6 +123149,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 @@ -123286,6 +124536,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 @@ -124380,6 +125632,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 @@ -125353,6 +126607,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 @@ -126308,6 +127564,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 @@ -127265,6 +128523,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 @@ -128246,6 +129506,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 @@ -129196,6 +130458,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 @@ -130128,6 +131392,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 @@ -131521,6 +132787,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 @@ -132522,6 +133790,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 @@ -133450,6 +134720,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 @@ -134996,6 +136268,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 @@ -209712,6 +210986,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 @@ -209976,127 +211380,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 @@ -214186,6 +215469,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 @@ -232765,6 +234075,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 @@ -232808,13 +234125,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-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json index 9e01ccbc39..2974636fc7 100644 --- a/descriptions-next/api.github.com/api.github.com.json +++ b/descriptions-next/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": [ @@ -6372,6 +6376,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", @@ -14117,7 +14768,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" ], @@ -17916,7 +18567,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" ], @@ -22806,6 +23457,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", @@ -29078,6 +29921,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", @@ -49393,6 +50542,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", @@ -102675,6 +104138,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.", @@ -102970,6 +104457,9 @@ }, "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" + }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" } }, "required": [ @@ -105648,6 +107138,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" + } + } + }, "dependabot-repository-access-details": { "title": "Dependabot Repository Access Details", "description": "Information about repositories that Dependabot is able to access in an organization", @@ -113467,6 +115075,111 @@ } ] }, + "secret-scanning-row-version": { + "type": [ + "string", + "null" + ], + "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." + }, + "secret-scanning-pattern-override": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern." + }, + "custom_pattern_version": { + "type": [ + "string", + "null" + ], + "description": "The version of this pattern if it's a custom pattern." + }, + "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", + "null" + ], + "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", + null + ] + }, + "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", @@ -131981,6 +133694,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "type": "string" }, @@ -138881,6 +140597,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", @@ -140320,6 +142039,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", @@ -141921,6 +143643,83 @@ "updated_at" ] }, + "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", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "status": { + "type": [ + "string", + "null" + ], + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + "start_date": { + "type": "string", + "format": "date", + "examples": [ + "2022-04-28" + ] + }, + "target_date": { + "type": "string", + "format": "date", + "examples": [ + "2022-04-28" + ] + }, + "body": { + "description": "Body of the status update", + "type": [ + "string", + "null" + ], + "examples": [ + "The project is off to a great start!" + ] + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ] + }, "projects-v2": { "title": "Projects v2 Project", "description": "A projects v2 project", @@ -142002,6 +143801,27 @@ "$ref": "#/components/schemas/simple-user" } ] + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "latest_status_update": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/projects-v2-status-update" + } + ] + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" } }, "required": [ @@ -142170,83 +143990,6 @@ "title" ] }, - "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", - "examples": [ - "2022-04-28T12:00:00Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2022-04-28T12:00:00Z" - ] - }, - "status": { - "type": [ - "string", - "null" - ], - "enum": [ - "INACTIVE", - "ON_TRACK", - "AT_RISK", - "OFF_TRACK", - "COMPLETE", - null - ] - }, - "start_date": { - "type": "string", - "format": "date", - "examples": [ - "2022-04-28" - ] - }, - "target_date": { - "type": "string", - "format": "date", - "examples": [ - "2022-04-28" - ] - }, - "body": { - "description": "Body of the status update", - "type": [ - "string", - "null" - ], - "examples": [ - "The project is off to a great start!" - ] - } - }, - "required": [ - "id", - "node_id", - "created_at", - "updated_at" - ] - }, "webhooks_number": { "description": "The pull request number.", "type": "integer" @@ -164480,6 +166223,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", @@ -166118,6 +167864,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", @@ -167765,6 +169514,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", @@ -169654,6 +171406,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", @@ -171152,6 +172907,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", @@ -172454,6 +174212,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", @@ -173747,6 +175508,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", @@ -175033,6 +176797,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", @@ -176347,6 +178114,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", @@ -177625,6 +179395,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", @@ -178884,6 +180657,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", @@ -180754,6 +182530,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", @@ -182095,6 +183874,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", @@ -183348,6 +185130,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", @@ -185420,6 +187205,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", @@ -284069,6 +285857,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", @@ -284389,136 +286320,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, @@ -289377,6 +291178,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": [ { @@ -310884,6 +312720,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.", @@ -310929,15 +312774,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-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml index 4f706a82fd..785d0304ff 100644 --- a/descriptions-next/api.github.com/api.github.com.yaml +++ b/descriptions-next/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: @@ -4500,6 +4502,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 @@ -10308,7 +10762,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: @@ -13028,7 +13482,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. @@ -16567,6 +17021,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 @@ -21155,6 +21740,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 @@ -36109,6 +36903,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 @@ -74452,6 +75477,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 @@ -74651,6 +75693,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 @@ -76574,6 +77618,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 dependabot-repository-access-details: title: Dependabot Repository Access Details description: Information about repositories that Dependabot is able to access @@ -82474,6 +83613,93 @@ components: state: type: object description: The state of the ruleset version + secret-scanning-row-version: + type: + - string + - 'null' + 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. + secret-scanning-pattern-override: + type: object + properties: + token_type: + type: string + description: The ID of the pattern. + custom_pattern_version: + type: + - string + - 'null' + description: The version of this pattern if it's a custom pattern. + 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 + - 'null' + 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 + - + 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. @@ -95631,6 +96857,8 @@ components: - 'null' sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: type: string state_reason: @@ -100735,6 +101963,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 @@ -101805,6 +103035,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 @@ -102997,6 +104229,62 @@ components: - name - created_at - updated_at + 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 + examples: + - '2022-04-28T12:00:00Z' + updated_at: + type: string + format: date-time + examples: + - '2022-04-28T12:00:00Z' + status: + type: + - string + - 'null' + enum: + - INACTIVE + - ON_TRACK + - AT_RISK + - OFF_TRACK + - COMPLETE + - + start_date: + type: string + format: date + examples: + - '2022-04-28' + target_date: + type: string + format: date + examples: + - '2022-04-28' + body: + description: Body of the status update + type: + - string + - 'null' + examples: + - The project is off to a great start! + required: + - id + - node_id + - created_at + - updated_at projects-v2: title: Projects v2 Project description: A projects v2 project @@ -103052,6 +104340,18 @@ components: anyOf: - type: 'null' - "$ref": "#/components/schemas/simple-user" + state: + type: string + enum: + - open + - closed + latest_status_update: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/projects-v2-status-update" + is_template: + type: boolean + description: Whether this project is a template required: - id - node_id @@ -103172,62 +104472,6 @@ components: required: - id - title - 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 - examples: - - '2022-04-28T12:00:00Z' - updated_at: - type: string - format: date-time - examples: - - '2022-04-28T12:00:00Z' - status: - type: - - string - - 'null' - enum: - - INACTIVE - - ON_TRACK - - AT_RISK - - OFF_TRACK - - COMPLETE - - - start_date: - type: string - format: date - examples: - - '2022-04-28' - target_date: - type: string - format: date - examples: - - '2022-04-28' - body: - description: Body of the status update - type: - - string - - 'null' - examples: - - The project is off to a great start! - required: - - id - - node_id - - created_at - - updated_at webhooks_number: description: The pull request number. type: integer @@ -119492,6 +120736,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 @@ -120693,6 +121939,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 @@ -121901,6 +123149,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 @@ -123286,6 +124536,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 @@ -124380,6 +125632,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 @@ -125353,6 +126607,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 @@ -126308,6 +127564,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 @@ -127265,6 +128523,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 @@ -128246,6 +129506,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 @@ -129196,6 +130458,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 @@ -130128,6 +131392,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 @@ -131521,6 +132787,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 @@ -132522,6 +133790,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 @@ -133450,6 +134720,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 @@ -134996,6 +136268,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 @@ -209712,6 +210986,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 @@ -209976,127 +211380,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 @@ -214186,6 +215469,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 @@ -232765,6 +234075,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 @@ -232808,13 +234125,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-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index 4d2868b329..6a2054eea1 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -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": [ @@ -29427,6 +29431,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": [ @@ -47569,6 +47597,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": [ @@ -54344,6 +54396,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": [ @@ -58554,17 +58630,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": [ { @@ -58575,29 +58651,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": { @@ -58606,666 +58659,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", - "null" - ], - "description": "The default repository access level for Dependabot updates.", - "enum": [ - "public", - "internal", - null - ], - "examples": [ - "internal" - ] + "days": { + "type": "integer", + "description": "The number of days artifacts and logs are retained" }, - "accessible_repositories": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple Repository", - "description": "A GitHub repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "A unique identifier of the repository.", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "description": "The GraphQL identifier of the repository.", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "description": "The name of the repository.", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "description": "The full, globally unique, name of the repository.", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean", - "description": "Whether the repository is private." - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL to view the repository on GitHub.com.", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The repository description.", - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL to get more information about the repository from the GitHub API.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "description": "A template for the API URL to download the repository as an archive.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "description": "A template for the API URL to list the available assignees for issues in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "description": "A template for the API URL to get information about branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "description": "A template for the API URL to get information about collaborators of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "description": "A template for the API URL to get information about comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "description": "A template for the API URL to get information about commits on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "description": "A template for the API URL to compare two commits or refs.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "description": "A template for the API URL to get the contents of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "description": "A template for the API URL to list the contributors to the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the deployments of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the downloads on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the events of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the forks of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "description": "A template for the API URL to get information about Git commits of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "description": "A template for the API URL to get information about Git refs of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "description": "A template for the API URL to get information about Git tags of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "issue_comment_url": { - "type": "string", - "description": "A template for the API URL to get information about issue comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "description": "A template for the API URL to get information about issue events on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "description": "A template for the API URL to get information about issues on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "description": "A template for the API URL to get information about deploy keys on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "description": "A template for the API URL to get information about labels of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about the languages of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "description": "The API URL to merge branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "description": "A template for the API URL to get information about milestones of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "description": "A template for the API URL to get information about notifications on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "description": "A template for the API URL to get information about pull requests on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "description": "A template for the API URL to get information about releases on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the stargazers on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "description": "A template for the API URL to get information about statuses of a commit.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the subscribers on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "description": "The API URL to subscribe to notifications for this repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about tags on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the teams on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the hooks on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks" - ] - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" - ] - } - ] - } + "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 } } } @@ -59326,22 +58741,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": [ { @@ -59361,50 +58775,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 } } } @@ -59413,7 +58796,7 @@ }, "responses": { "204": { - "description": "Response" + "description": "No content" }, "403": { "description": "Forbidden", @@ -59466,27 +58849,127 @@ } } } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "repository-access" + "category": "actions", + "subcategory": "permissions" } } }, - "/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.", + "/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": [ - "dependabot" + "actions" ], - "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" + "url": "https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization" }, "parameters": [ { @@ -59499,46 +58982,40 @@ } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "default_level": { - "type": "string", - "description": "The default repository access level for Dependabot updates.", - "enum": [ - "public", - "internal" - ], - "examples": [ - "internal" - ] - } + "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" + ] }, - "required": [ - "default_level" - ] - }, - "examples": { - "204": { - "summary": "Example with a 'succeeded' status.", - "value": { - "default_level": "public" + "examples": { + "default": { + "value": { + "approval_policy": "first_time_contributors" + } } } } } - } - }, - "responses": { - "204": { - "description": "Response" }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -59562,6 +59039,39 @@ } } } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set fork PR contributor approval permissions for an organization", + "description": "Sets the fork PR contributor approval policy for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/set-fork-pr-contributor-approval-permissions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" }, "404": { "description": "Resource not found", @@ -59588,27 +59098,133 @@ } } } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "approval_policy": { + "type": "string", + "enum": [ + "first_time_contributors_new_to_github", + "first_time_contributors", + "all_external_contributors" + ], + "description": "The policy that controls when fork PR workflows require approval from a maintainer." + } + }, + "required": [ + "approval_policy" + ] + }, + "examples": { + "default": { + "summary": "Set approval policy to first time contributors", + "value": { + "approval_policy": "first_time_contributors" + } + } + } + } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "repository-access" + "category": "actions", + "subcategory": "permissions" } } }, - "/organizations/{org}/settings/billing/usage": { + "/organizations/{org}/actions/permissions/fork-pr-workflows-private-repos": { "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 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": [ - "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-private-repo-fork-pr-workflow-settings-for-an-organization" }, "parameters": [ { @@ -59619,144 +59235,55 @@ "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", + "required": [ + "run_workflows_from_fork_pull_requests", + "send_write_tokens_to_workflows", + "send_secrets_and_variables", + "require_approval_for_fork_pr_workflows" + ], "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" - ] - } + "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": { - "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" - } - ] + "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 } } } } } }, - "400": { - "description": "Bad Request", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -59778,53 +59305,111 @@ } } } - }, - "application/scim+json": { + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { "schema": { - "title": "Scim Error", - "description": "Scim Error", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { "message": { - "type": [ - "string", - "null" - ] + "type": "string" }, "documentation_url": { - "type": [ - "string", - "null" - ] + "type": "string" }, - "detail": { - "type": [ - "string", - "null" - ] + "url": { + "type": "string" }, "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } + "type": "string" } } } } } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set private repo fork PR workflow settings for an organization", + "description": "Sets the settings for whether workflows from fork pull requests can run on private repositories in an organization.", + "operationId": "actions/set-private-repo-fork-pr-workflows-settings-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "run_workflows_from_fork_pull_requests" + ], + "properties": { + "run_workflows_from_fork_pull_requests": { + "type": "boolean", + "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." + }, + "send_write_tokens_to_workflows": { + "type": "boolean", + "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request." + }, + "send_secrets_and_variables": { + "type": "boolean", + "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks." + }, + "require_approval_for_fork_pr_workflows": { + "type": "boolean", + "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run." + } + } + }, + "examples": { + "default": { + "value": { + "run_workflows_from_fork_pull_requests": true, + "send_write_tokens_to_workflows": false, + "send_secrets_and_variables": false, + "require_approval_for_fork_pr_workflows": true + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Empty response for successful settings update" }, "403": { - "description": "Forbidden", + "description": "Forbidden - Fork PR workflow settings for private repositories are managed by the enterprise owner", "content": { "application/json": { "schema": { @@ -59849,8 +59434,8 @@ } } }, - "500": { - "description": "Internal Error", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -59875,21 +59460,75 @@ } } }, - "503": { - "description": "Service unavailable", + "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": { - "code": { - "type": "string" - }, "message": { "type": "string" }, "documentation_url": { "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } } } } @@ -59898,24 +59537,23 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "billing", - "subcategory": "enhanced-billing" + "category": "actions", + "subcategory": "permissions" } } }, - "/orgs/{org}": { + "/organizations/{org}/actions/permissions/self-hosted-runners": { "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 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" ], - "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-self-hosted-runners-settings-for-an-organization" }, "parameters": [ { @@ -59934,590 +59572,58 @@ "content": { "application/json": { "schema": { - "title": "Organization Full", - "description": "Organization Full", "type": "object", + "required": [ + "enabled_repositories" + ], "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - }, - "name": { - "type": "string", - "examples": [ - "github" - ] - }, - "company": { - "type": "string", - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": "string", - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": "string", - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "github" - ] - }, - "is_verified": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_organization_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_repository_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "private_gists": { - "type": [ - "integer", - "null" - ], - "examples": [ - 81 - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ], - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ], - "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000.", - "examples": [ - 8 - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } - }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": [ - "string", - "null" - ] - }, - "default_repository_branch": { - "type": [ - "string", - "null" - ], - "description": "The default branch for repositories created in this organization.", - "examples": [ - "main" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "members_allowed_repository_creation_type": { - "type": "string", - "examples": [ - "all" - ] - }, - "members_can_create_public_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_public_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_delete_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_change_repo_visibility": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_invite_outside_collaborators": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_delete_issues": { - "type": "boolean", - "examples": [ - true - ] - }, - "display_commenter_full_name_setting_enabled": { - "type": "boolean", - "examples": [ - true - ] - }, - "readers_can_create_discussions": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_teams": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_view_dependency_insights": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "advanced_security_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "dependabot_alerts_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "dependabot_security_updates_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "dependency_graph_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "secret_scanning_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "secret_scanning_push_protection_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "secret_scanning_push_protection_custom_link_enabled": { - "type": "boolean", - "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", - "examples": [ - false - ] - }, - "secret_scanning_push_protection_custom_link": { - "type": [ - "string", - "null" - ], - "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", - "examples": [ - "https://github.com/test-org/test-repo/blob/main/README.md" - ] - }, - "created_at": { + "enabled_repositories": { "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" + "description": "The policy that controls whether self-hosted runners can be used by repositories in the organization", + "enum": [ + "all", + "selected", + "none" ] }, - "updated_at": { + "selected_repositories_url": { "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "deploy_keys_enabled_for_repositories": { - "type": "boolean", - "description": "Controls whether or not deploy keys may be added and used for repositories in the organization.", - "examples": [ - false - ] + "description": "The URL to the endpoint for managing selected repositories for self-hosted runners 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-response": { + "response": { + "summary": "Example response", "value": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "twitter_username": "github", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "type": "Organization", - "total_private_repos": 100, - "owned_private_repos": 100, - "private_gists": 81, - "disk_usage": 10000, - "collaborators": 8, - "billing_email": "mona@github.com", - "plan": { - "name": "Medium", - "space": 400, - "private_repos": 20, - "filled_seats": 4, - "seats": 5 - }, - "default_repository_permission": "read", - "default_repository_branch": "main", - "members_can_create_repositories": true, - "two_factor_requirement_enabled": true, - "members_allowed_repository_creation_type": "all", - "members_can_create_public_repositories": false, - "members_can_create_private_repositories": false, - "members_can_create_internal_repositories": false, - "members_can_create_pages": true, - "members_can_create_public_pages": true, - "members_can_create_private_pages": true, - "members_can_delete_repositories": true, - "members_can_change_repo_visibility": true, - "members_can_invite_outside_collaborators": true, - "members_can_delete_issues": false, - "display_commenter_full_name_setting_enabled": false, - "readers_can_create_discussions": true, - "members_can_create_teams": true, - "members_can_view_dependency_insights": true, - "members_can_fork_private_repositories": false, - "web_commit_signoff_required": false, - "updated_at": "2014-03-03T18:58:10Z", - "deploy_keys_enabled_for_repositories": false, - "dependency_graph_enabled_for_new_repositories": false, - "dependabot_alerts_enabled_for_new_repositories": false, - "dependabot_security_updates_enabled_for_new_repositories": false, - "advanced_security_enabled_for_new_repositories": false, - "secret_scanning_enabled_for_new_repositories": false, - "secret_scanning_push_protection_enabled_for_new_repositories": false, - "secret_scanning_push_protection_custom_link": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md", - "secret_scanning_push_protection_custom_link_enabled": false + "enabled_repositories": "selected", + "selected_repositories_url": "http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories" + } + } + } + } + } + }, + "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" } } } @@ -60552,22 +59658,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 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": [ - "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-self-hosted-runners-settings-for-an-organization" }, "parameters": [ { @@ -60581,173 +59686,30 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { "type": "object", + "required": [ + "enabled_repositories" + ], "properties": { - "billing_email": { - "type": "string", - "description": "Billing email address. This address is not publicized." - }, - "company": { - "type": "string", - "description": "The company name." - }, - "email": { - "type": "string", - "description": "The publicly visible email address." - }, - "twitter_username": { - "type": "string", - "description": "The Twitter username of the company." - }, - "location": { - "type": "string", - "description": "The location." - }, - "name": { - "type": "string", - "description": "The shorthand name of the company." - }, - "description": { - "type": "string", - "description": "The description of the company. The maximum size is 160 characters." - }, - "has_organization_projects": { - "type": "boolean", - "description": "Whether an organization can use organization projects." - }, - "has_repository_projects": { - "type": "boolean", - "description": "Whether repositories that belong to the organization can use repository projects." - }, - "default_repository_permission": { - "type": "string", - "description": "Default permission level members have for organization repositories.", - "enum": [ - "read", - "write", - "admin", - "none" - ], - "default": "read" - }, - "members_can_create_repositories": { - "type": "boolean", - "description": "Whether of non-admin organization members can create repositories. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.", - "default": true - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "description": "Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." - }, - "members_can_create_private_repositories": { - "type": "boolean", - "description": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." - }, - "members_can_create_public_repositories": { - "type": "boolean", - "description": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." - }, - "members_allowed_repository_creation_type": { + "enabled_repositories": { "type": "string", - "description": "Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n**Note:** This parameter is closing down and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.", + "description": "The policy that controls whether self-hosted runners can be used in the organization", "enum": [ "all", - "private", + "selected", "none" ] - }, - "members_can_create_pages": { - "type": "boolean", - "description": "Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.", - "default": true - }, - "members_can_create_public_pages": { - "type": "boolean", - "description": "Whether organization members can create public GitHub Pages sites. Existing published sites will not be impacted.", - "default": true - }, - "members_can_create_private_pages": { - "type": "boolean", - "description": "Whether organization members can create private GitHub Pages sites. Existing published sites will not be impacted.", - "default": true - }, - "members_can_fork_private_repositories": { - "type": "boolean", - "description": "Whether organization members can fork private organization repositories.", - "default": false - }, - "web_commit_signoff_required": { - "type": "boolean", - "description": "Whether contributors to organization repositories are required to sign off on commits they make through GitHub's web interface.", - "default": false - }, - "blog": { - "type": "string", - "examples": [ - "\"http://github.blog\"" - ] - }, - "advanced_security_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", - "deprecated": true - }, - "dependabot_alerts_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", - "deprecated": true - }, - "dependabot_security_updates_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", - "deprecated": true - }, - "dependency_graph_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", - "deprecated": true - }, - "secret_scanning_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", - "deprecated": true - }, - "secret_scanning_push_protection_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", - "deprecated": true - }, - "secret_scanning_push_protection_custom_link_enabled": { - "type": "boolean", - "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection." - }, - "secret_scanning_push_protection_custom_link": { - "type": "string", - "description": "If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret." - }, - "deploy_keys_enabled_for_repositories": { - "type": "boolean", - "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } } }, "examples": { - "default": { + "application/json": { "value": { - "billing_email": "mona@github.com", - "company": "GitHub", - "email": "mona@github.com", - "twitter_username": "github", - "location": "San Francisco", - "name": "github", - "description": "GitHub, the company.", - "default_repository_permission": "read", - "members_can_create_repositories": true, - "members_allowed_repository_creation_type": "all" + "enabled_repositories": "all" } } } @@ -60755,705 +59717,1339 @@ } }, "responses": { - "200": { - "description": "Response", + "204": { + "description": "No content" + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] + "message": { + "type": "string" }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] + "documentation_url": { + "type": "string" }, "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - }, - "name": { - "type": "string", - "examples": [ - "github" - ] - }, - "company": { - "type": "string", - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": "string", - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": "string", - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "github" - ] - }, - "is_verified": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_organization_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_repository_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] + "type": "string" }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "type": { - "type": "string", - "examples": [ - "Organization" - ] + "documentation_url": { + "type": "string" }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] + "url": { + "type": "string" }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] + "status": { + "type": "string" + } + } + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "private_gists": { - "type": [ - "integer", - "null" - ], - "examples": [ - 81 - ] + "documentation_url": { + "type": "string" }, - "disk_usage": { - "type": [ - "integer", - "null" - ], - "examples": [ - 10000 - ] + "url": { + "type": "string" }, - "collaborators": { - "type": [ - "integer", - "null" - ], - "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000.", - "examples": [ - 8 - ] + "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" }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "org@example.com" - ] + "documentation_url": { + "type": "string" }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } } - }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": [ - "string", - "null" - ] - }, - "default_repository_branch": { - "type": [ - "string", - "null" - ], - "description": "The default branch for repositories created in this organization.", - "examples": [ - "main" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "members_allowed_repository_creation_type": { - "type": "string", - "examples": [ - "all" - ] - }, - "members_can_create_public_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_public_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_delete_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_change_repo_visibility": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_invite_outside_collaborators": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_delete_issues": { - "type": "boolean", - "examples": [ - true - ] - }, - "display_commenter_full_name_setting_enabled": { - "type": "boolean", - "examples": [ - true - ] - }, - "readers_can_create_discussions": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_teams": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_view_dependency_insights": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "advanced_security_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "dependabot_alerts_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true + } + } + } + } + } + } + } + }, + "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": [ + { + "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", + "properties": { + "total_count": { + "type": "integer" }, - "dependabot_security_updates_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "dependency_graph_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "secret_scanning_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "secret_scanning_push_protection_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "secret_scanning_push_protection_custom_link_enabled": { - "type": "boolean", - "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", - "examples": [ - false - ] - }, - "secret_scanning_push_protection_custom_link": { - "type": [ - "string", - "null" - ], - "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", - "examples": [ - "https://github.com/test-org/test-repo/blob/main/README.md" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "deploy_keys_enabled_for_repositories": { - "type": "boolean", - "description": "Controls whether or not deploy keys may be added and used for repositories in the organization.", - "examples": [ - false - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at", - "archived_at" - ] - }, - "examples": { - "default": { - "value": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "twitter_username": "github", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "type": "Organization", - "total_private_repos": 100, - "owned_private_repos": 100, - "private_gists": 81, - "disk_usage": 10000, - "collaborators": 8, - "billing_email": "mona@github.com", - "plan": { - "name": "Medium", - "space": 400, - "private_repos": 20, - "filled_seats": 4, - "seats": 5 - }, - "default_repository_permission": "read", - "default_repository_branch": "main", - "members_can_create_repositories": true, - "two_factor_requirement_enabled": true, - "members_allowed_repository_creation_type": "all", - "members_can_create_public_repositories": false, - "members_can_create_private_repositories": false, - "members_can_create_internal_repositories": false, - "members_can_create_pages": true, - "members_can_create_public_pages": true, - "members_can_create_private_pages": true, - "members_can_delete_repositories": true, - "members_can_change_repo_visibility": true, - "members_can_invite_outside_collaborators": true, - "members_can_delete_issues": false, - "display_commenter_full_name_setting_enabled": false, - "readers_can_create_discussions": true, - "members_can_create_teams": true, - "members_can_view_dependency_insights": true, - "members_can_fork_private_repositories": false, - "web_commit_signoff_required": false, - "updated_at": "2014-03-03T18:58:10Z", - "deploy_keys_enabled_for_repositories": false, - "dependency_graph_enabled_for_new_repositories": false, - "dependabot_alerts_enabled_for_new_repositories": false, - "dependabot_security_updates_enabled_for_new_repositories": false, - "advanced_security_enabled_for_new_repositories": false, - "secret_scanning_enabled_for_new_repositories": false, - "secret_scanning_push_protection_enabled_for_new_repositories": false, - "secret_scanning_push_protection_custom_link": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md", - "secret_scanning_push_protection_custom_link_enabled": false - } - } - } - } - } - }, - "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" + "repositories": { + "type": "array", + "items": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" ] }, - { + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { "type": [ - "integer", + "string", "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" ] }, - { + "spdx_id": { "type": [ - "array", + "string", "null" ], - "items": { - "type": "string" - } + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "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": { + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } } - } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] } } - ] + } + }, + "examples": { + "default": { + "value": { + "total_count": 1, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + ] + } + } } } } }, - "409": { - "description": "Conflict", + "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": { @@ -61480,22 +61076,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "orgs" + "category": "actions", + "subcategory": "permissions" } }, - "delete": { - "summary": "Delete an organization", - "description": "Deletes an organization and all its repositories.\n\nThe organization login will be unavailable for 90 days after deletion.\n\nPlease review the Terms of Service regarding account deletion before using this endpoint:\n\nhttps://docs.github.com/site-policy/github-terms/github-terms-of-service", - "operationId": "orgs/delete", + "put": { + "summary": "Set 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": [ - "orgs" + "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/orgs#delete-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization" }, "parameters": [ { @@ -61508,24 +61103,45 @@ } } ], - "responses": { - "202": { - "description": "Accepted", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "default": { - "value": null + "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" }, - "404": { - "description": "Resource not found", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -61550,8 +61166,8 @@ } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -61575,27 +61191,101 @@ } } } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "orgs" + "category": "actions", + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/cache/usage": { - "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.", + "/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" ], - "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#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" }, "parameters": [ { @@ -61606,69 +61296,191 @@ "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": { - "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } } } } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "cache" + "subcategory": "permissions" } - } - }, - "/orgs/{org}/actions/cache/usage-by-repository": { - "get": { - "summary": "List repositories with GitHub Actions cache usage for an organization", - "description": "Lists repositories and their GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\n\nOAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + }, + "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" ], - "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#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" }, "parameters": [ { @@ -61681,127 +61493,191 @@ } }, { - "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": "repository_id", + "description": "The unique identifier of the repository.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "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", - "repository_cache_usages" + "message", + "documentation_url" ], "properties": { - "total_count": { - "type": "integer" + "message": { + "type": "string" }, - "repository_cache_usages": { + "documentation_url": { + "type": "string" + }, + "errors": { "type": "array", "items": { - "title": "Actions Cache Usage by repository", - "description": "GitHub Actions Cache Usage by repository.", "type": "object", + "required": [ + "code" + ], "properties": { - "full_name": { - "description": "The repository owner and name for the cache usage being shown.", - "type": "string", - "examples": [ - "octo-org/Hello-World" - ] + "resource": { + "type": "string" }, - "active_caches_size_in_bytes": { - "description": "The sum of the size in bytes of all the active cache items in the repository.", - "type": "integer", - "examples": [ - 2322142 - ] + "field": { + "type": "string" }, - "active_caches_count": { - "description": "The number of active caches in the repository.", - "type": "integer", - "examples": [ - 3 + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } ] } - }, - "required": [ - "full_name", - "active_caches_size_in_bytes", - "active_caches_count" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 2, - "repository_cache_usages": [ - { - "full_name": "octo-org/Hello-World", - "active_caches_size_in_bytes": 2322142, - "active_caches_count": 3 - }, - { - "full_name": "octo-org/server", - "active_caches_size_in_bytes": 1022142, - "active_caches_count": 2 } - ] + } } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "cache" + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/hosted-runners": { + "/organizations/{org}/dependabot/repository-access": { "get": { - "summary": "List GitHub-hosted runners for an organization", - "description": "Lists all GitHub-hosted runners configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runner:org` scope to use this endpoint.", + "summary": "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/list-hosted-runners-for-org", + "operationId": "dependabot/repository-access-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization" + "url": "https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization" }, "parameters": [ { @@ -61814,21 +61690,26 @@ } }, { - "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": "page", "in": "query", + "description": "The page number of results to fetch.", + "required": false, "schema": { "type": "integer", - "default": 30 + "minimum": 1, + "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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "name": "per_page", "in": "query", + "description": "Number of results per page.", + "required": false, "schema": { "type": "integer", - "default": 1 + "minimum": 1, + "maximum": 100, + "default": 30 } } ], @@ -61838,291 +61719,720 @@ "content": { "application/json": { "schema": { + "title": "Dependabot Repository Access Details", + "description": "Information about repositories that Dependabot is able to access in an organization", "type": "object", - "required": [ - "total_count", - "runners" - ], "properties": { - "total_count": { - "type": "integer" + "default_level": { + "type": [ + "string", + "null" + ], + "description": "The default repository access level for Dependabot updates.", + "enum": [ + "public", + "internal", + null + ], + "examples": [ + "internal" + ] }, - "runners": { + "accessible_repositories": { "type": "array", "items": { - "title": "GitHub-hosted hosted runner", - "description": "A Github-hosted hosted runner.", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the hosted runner.", - "type": "integer", - "examples": [ - 5 - ] - }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "examples": [ - "my-github-hosted-runner" - ] - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "examples": [ - 2 - ] + "anyOf": [ + { + "type": "null" }, - "image_details": { - "anyOf": [ - { - "type": "null" + { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "A unique identifier of the repository.", + "examples": [ + 1296269 + ] }, - { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository.", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "description": "The name of the repository.", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository.", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "examples": [ - "ubuntu-20.04" + "name": { + "type": [ + "string", + "null" ] }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "examples": [ - 86 + "email": { + "type": [ + "string", + "null" ] }, - "display_name": { - "description": "Display name for this image.", + "login": { "type": "string", "examples": [ - 20.04 + "octocat" ] }, - "source": { - "description": "The image provider.", + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { "type": "string", - "enum": [ - "github", - "partner", - "custom" + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", "id", - "size_gb", - "display_name", - "source" + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] - } - ] - }, - "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.", + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com.", "examples": [ - "8-core" + "https://github.com/octocat/Hello-World" ] }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description.", "examples": [ - 8 + "This your first repo!" ] }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API.", "examples": [ - 32 + "https://api.github.com/repos/octocat/Hello-World" ] }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive.", "examples": [ - 300 + "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks" ] } }, "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ], - "examples": [ - "Ready" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "examples": [ - "linux-x64" - ] - }, - "maximum_runners": { - "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", - "type": "integer", - "default": 10, - "examples": [ - 5 - ] - }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", - "type": "boolean", - "examples": [ - true - ] - }, - "public_ips": { - "description": "The public IP ranges when public IP is enabled for the hosted runners.", - "type": "array", - "items": { - "title": "Public IP for a GitHub-hosted larger runners.", - "description": "Provides details of Public IP for a GitHub-hosted larger runners", - "type": "object", - "properties": { - "enabled": { - "description": "Whether public IP is enabled.", - "type": "boolean", - "examples": [ - true - ] - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "examples": [ - "20.80.208.150" - ] - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "examples": [ - 28 - ] - } - } - } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2022-10-09T23:39:01Z" + "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": [ - "id", - "name", - "image_details", - "machine_size_details", - "status", - "public_ip_enabled", - "platform" ] } } - } + }, + "additionalProperties": false }, "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" - }, + "default_level": "public", + "accessible_repositories": [ { - "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 + "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" }, - "status": "Ready", - "maximum_runners": 20, - "public_ip_enabled": false, - "public_ips": [], - "last_active_on": "2023-04-26T15:23:37Z" + "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" } ] } } } } - }, - "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" + } + } } } } @@ -62131,20 +62441,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "hosted-runners" + "category": "dependabot", + "subcategory": "repository-access" } }, - "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", + "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/hosted-runners#create-a-github-hosted-runner-for-an-organization" + "url": "https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization" }, "parameters": [ { @@ -62164,65 +62474,50 @@ "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" + "repository_ids_to_add": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of repository IDs to add." }, - "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" + "repository_ids_to_remove": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of repository IDs to remove." } }, - "required": [ - "name", - "image", - "size", - "runner_group_id" - ] + "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": { - "name": "My Hosted runner", - "image": { - "id": "ubuntu-latest", - "source": "github" - }, - "runner_group_id": 1, - "size": "4-core", - "maximum_runners": 50, - "enable_static_ip": false + "repository_ids_to_add": [ + 123, + 456 + ] + } + }, + "remove-example": { + "summary": "Remove repositories", + "value": { + "repository_ids_to_remove": [ + 789 + ] } } } @@ -62230,245 +62525,55 @@ } }, "responses": { - "201": { - "description": "Response", + "204": { + "description": "Response" + }, + "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", - "examples": [ - 5 - ] - }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "examples": [ - "my-github-hosted-runner" - ] - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "examples": [ - 2 - ] + "message": { + "type": "string" }, - "image_details": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", - "type": "object", - "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "examples": [ - "ubuntu-20.04" - ] - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "examples": [ - 86 - ] - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "examples": [ - 20.04 - ] - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ] - } - ] + "documentation_url": { + "type": "string" }, - "machine_size_details": { - "title": "Github-owned VM details.", - "description": "Provides details of a particular machine spec.", - "type": "object", - "properties": { - "id": { - "description": "The ID used for the `size` parameter when creating a new runner.", - "type": "string", - "examples": [ - "8-core" - ] - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "examples": [ - 8 - ] - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "examples": [ - 32 - ] - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "examples": [ - 300 - ] - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] + "url": { + "type": "string" }, "status": { - "description": "The status of the runner.", - "type": "string", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ], - "examples": [ - "Ready" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "examples": [ - "linux-x64" - ] - }, - "maximum_runners": { - "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", - "type": "integer", - "default": 10, - "examples": [ - 5 - ] + "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", - "examples": [ - 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", - "examples": [ - true - ] - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "examples": [ - "20.80.208.150" - ] - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "examples": [ - 28 - ] - } - } - } + "url": { + "type": "string" }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2022-10-09T23:39:01Z" - ] - } - }, - "required": [ - "id", - "name", - "image_details", - "machine_size_details", - "status", - "public_ip_enabled", - "platform" - ] - }, - "examples": { - "default": { - "value": { - "id": 5, - "name": "My hosted ubuntu runner", - "runner_group_id": 2, - "platform": "linux-x64", - "image": { - "id": "ubuntu-20.04", - "size": 86 - }, - "machine_size_details": { - "id": "4-core", - "cpu_cores": 4, - "memory_gb": 16, - "storage_gb": 150 - }, - "status": "Ready", - "maximum_runners": 10, - "public_ip_enabled": true, - "public_ips": [ - { - "enabled": true, - "prefix": "20.80.208.150", - "length": 31 - } - ], - "last_active_on": "2022-10-09T23:39:01Z" + "status": { + "type": "string" } } } @@ -62477,24 +62582,24 @@ } }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, - "category": "actions", - "subcategory": "hosted-runners" + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "repository-access" } } }, - "/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", + "/organizations/{org}/dependabot/repository-access/default-level": { + "put": { + "summary": "Set the default repository access level for Dependabot", + "description": "Sets the default level of repository access Dependabot will have while performing an update. Available values are:\n- 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories.\n- 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories.\n\nUnauthorized users will not see the existence of this endpoint.\n\nThis operation supports both server-to-server and user-to-server access.", "tags": [ - "actions" + "dependabot" ], + "operationId": "dependabot/set-repository-access-default-level", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization" + "url": "https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot" }, "parameters": [ { @@ -62507,85 +62612,90 @@ } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "default_level": { + "type": "string", + "description": "The default repository access level for Dependabot updates.", + "enum": [ + "public", + "internal" + ], + "examples": [ + "internal" + ] + } + }, + "required": [ + "default_level" + ] + }, + "examples": { + "204": { + "summary": "Example with a 'succeeded' status.", + "value": { + "default_level": "public" + } + } + } + } + } + }, "responses": { - "200": { - "description": "Response", + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "required": [ - "total_count", - "images" - ], "properties": { - "total_count": { - "type": "integer" + "message": { + "type": "string" }, - "images": { - "type": "array", - "items": { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", - "type": "object", - "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "examples": [ - "ubuntu-20.04" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "examples": [ - "linux-x64" - ] - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "examples": [ - 86 - ] - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "examples": [ - 20.04 - ] - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "platform", - "size_gb", - "display_name", - "source" - ] - } + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } - }, - "examples": { - "default": { - "value": { - "id": "ubuntu-20.04", - "platform": "linux-x64", - "size_gb": 86, - "display_name": "20.04", - "source": "github" + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } @@ -62596,22 +62706,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "hosted-runners" + "category": "dependabot", + "subcategory": "repository-access" } } }, - "/orgs/{org}/actions/hosted-runners/images/partner": { + "/organizations/{org}/settings/billing/usage": { "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", + "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/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization" + "url": "https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization" }, "parameters": [ { @@ -62622,74 +62732,113 @@ "schema": { "type": "string" } + }, + { + "name": "year", + "description": "If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "month", + "description": "If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the default `year` is used.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "day", + "description": "If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "hour", + "description": "If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. If no `year`, `month`, or `day` is specified, the default `year`, `month`, and `day` are used.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } } ], "responses": { "200": { - "description": "Response", + "description": "Billing usage report response for an organization", "content": { "application/json": { "schema": { "type": "object", - "required": [ - "total_count", - "images" - ], "properties": { - "total_count": { - "type": "integer" - }, - "images": { + "usageItems": { "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.", + "date": { "type": "string", - "examples": [ - "ubuntu-20.04" - ] + "description": "Date of the usage line item." }, - "platform": { - "description": "The operating system of the image.", + "product": { "type": "string", - "examples": [ - "linux-x64" - ] + "description": "Product name." }, - "size_gb": { - "description": "Image size in GB.", + "sku": { + "type": "string", + "description": "SKU name." + }, + "quantity": { "type": "integer", - "examples": [ - 86 - ] + "description": "Quantity of the usage line item." }, - "display_name": { - "description": "Display name for this image.", + "unitType": { "type": "string", - "examples": [ - 20.04 - ] + "description": "Unit type of the usage line item." }, - "source": { - "description": "The image provider.", + "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", - "enum": [ - "github", - "partner", - "custom" - ] + "description": "Name of the organization." + }, + "repositoryName": { + "type": "string", + "description": "Name of the repository." } }, "required": [ - "id", - "platform", - "size_gb", - "display_name", - "source" + "date", + "product", + "sku", + "quantity", + "unitType", + "pricePerUnit", + "grossAmount", + "discountAmount", + "netAmount", + "organizationName" ] } } @@ -62698,269 +62847,162 @@ "examples": { "default": { "value": { - "id": "ubuntu-20.04", - "platform": "linux-x64", - "size_gb": 86, - "display_name": "20.04", - "source": "github" + "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" + } + ] } } } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "hosted-runners" - } - } - }, - "/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/hosted-runners#get-limits-on-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" - } - } - ], - "responses": { - "200": { - "description": "Response", + }, + "400": { + "description": "Bad Request", "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.", - "examples": [ - 50 - ] - }, - "current_usage": { - "type": "integer", - "description": "The current number of static public IP addresses in use by Hosted Runners.", - "examples": [ - 17 - ] - } - }, - "required": [ - "maximum", - "current_usage" - ] - } - }, - "required": [ - "public_ips" - ] - }, - "examples": { - "default": { - "value": { - "public_ips": { - "current_usage": 17, - "maximum": 50 - } + "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", - "content": { - "application/json": { + }, + "application/scim+json": { "schema": { + "title": "Scim Error", + "description": "Scim Error", "type": "object", - "required": [ - "total_count", - "machine_specs" - ], "properties": { - "total_count": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { "type": "integer" }, - "machine_specs": { + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { "type": "array", "items": { - "title": "Github-owned VM details.", - "description": "Provides details of a particular machine spec.", - "type": "object", - "properties": { - "id": { - "description": "The ID used for the `size` parameter when creating a new runner.", - "type": "string", - "examples": [ - "8-core" - ] - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "examples": [ - 8 - ] - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "examples": [ - 32 - ] - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "examples": [ - 300 - ] - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] + "type": "string" } } } - }, - "examples": { - "default": { - "value": { - "id": "4-core", - "cpu_cores": 4, - "memory_gb": 16, - "storage_gb": 150 + } + } + } + }, + "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": "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", + }, + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "required": [ - "total_count", - "platforms" - ], "properties": { - "total_count": { - "type": "integer" + "message": { + "type": "string" }, - "platforms": { - "type": "array", - "items": { - "type": "string" - } + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } - }, - "examples": { - "default": { - "value": { - "total_count": 1, - "platforms": [ - "linux-x64", - "win-x64" - ] + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" } } } @@ -62971,22 +63013,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "hosted-runners" + "category": "billing", + "subcategory": "enhanced-billing" } } }, - "/orgs/{org}/actions/hosted-runners/{hosted_runner_id}": { + "/orgs/{org}": { "get": { - "summary": "Get a GitHub-hosted runner for an organization", - "description": "Gets a GitHub-hosted runner configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "summary": "Get 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": "actions/get-hosted-runner-for-org", + "operationId": "orgs/get", "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/orgs/orgs#get-an-organization" }, "parameters": [ { @@ -62997,15 +63039,6 @@ "schema": { "type": "string" } - }, - { - "name": "hosted_runner_id", - "description": "Unique identifier of the GitHub-hosted runner.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { @@ -63014,250 +63047,618 @@ "content": { "application/json": { "schema": { - "title": "GitHub-hosted hosted runner", - "description": "A Github-hosted hosted runner.", + "title": "Organization Full", + "description": "Organization Full", "type": "object", "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, "id": { - "description": "The unique identifier of the hosted runner.", "type": "integer", "examples": [ - 5 + 1 ] }, - "name": { - "description": "The name of the hosted runner.", + "node_id": { "type": "string", "examples": [ - "my-github-hosted-runner" + "MDEyOk9yZ2FuaXphdGlvbjE=" ] }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", + "url": { + "type": "string", + "format": "uri", "examples": [ - 2 + "https://api.github.com/orgs/github" ] }, - "image_details": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", - "type": "object", - "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "examples": [ - "ubuntu-20.04" - ] - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "examples": [ - 86 - ] - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "examples": [ - 20.04 - ] - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ] - } + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" ] }, - "machine_size_details": { - "title": "Github-owned VM details.", - "description": "Provides details of a particular machine spec.", - "type": "object", - "properties": { - "id": { - "description": "The ID used for the `size` parameter when creating a new runner.", - "type": "string", - "examples": [ - "8-core" - ] - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "examples": [ - 8 - ] - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "examples": [ - 32 - ] - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "examples": [ - 300 - ] - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" ] }, - "status": { - "description": "The status of the runner.", + "hooks_url": { "type": "string", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ], "examples": [ - "Ready" + "https://api.github.com/orgs/github/hooks" ] }, - "platform": { - "description": "The operating system of the image.", + "issues_url": { "type": "string", "examples": [ - "linux-x64" + "https://api.github.com/orgs/github/issues" ] }, - "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, + "members_url": { + "type": "string", "examples": [ - 5 + "https://api.github.com/orgs/github/members{/member}" ] }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", - "type": "boolean", + "public_members_url": { + "type": "string", "examples": [ - true + "https://api.github.com/orgs/github/public_members{/member}" ] }, - "public_ips": { - "description": "The public IP ranges when public IP is enabled for the hosted runners.", - "type": "array", - "items": { - "title": "Public IP for a GitHub-hosted larger runners.", - "description": "Provides details of Public IP for a GitHub-hosted larger runners", - "type": "object", - "properties": { - "enabled": { - "description": "Whether public IP is enabled.", - "type": "boolean", - "examples": [ - true - ] - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "examples": [ - "20.80.208.150" - ] - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "examples": [ - 28 - ] - } - } - } + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", + "description": { "type": [ "string", "null" ], - "format": "date-time", "examples": [ - "2022-10-09T23:39:01Z" + "A great organization" ] - } - }, - "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 + }, + "name": { + "type": "string", + "examples": [ + "github" + ] + }, + "company": { + "type": "string", + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": "string", + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": "string", + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "github" + ] + }, + "is_verified": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_organization_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_repository_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "private_gists": { + "type": [ + "integer", + "null" + ], + "examples": [ + 81 + ] + }, + "disk_usage": { + "type": [ + "integer", + "null" + ], + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": [ + "integer", + "null" + ], + "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000.", + "examples": [ + 8 + ] + }, + "billing_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "org@example.com" + ] + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": [ + "string", + "null" + ] + }, + "default_repository_branch": { + "type": [ + "string", + "null" ], - "last_active_on": "2022-10-09T23:39:01Z" + "description": "The default branch for repositories created in this organization.", + "examples": [ + "main" + ] + }, + "members_can_create_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "two_factor_requirement_enabled": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "members_allowed_repository_creation_type": { + "type": "string", + "examples": [ + "all" + ] + }, + "members_can_create_public_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_public_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_delete_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_change_repo_visibility": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_invite_outside_collaborators": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_delete_issues": { + "type": "boolean", + "examples": [ + true + ] + }, + "display_commenter_full_name_setting_enabled": { + "type": "boolean", + "examples": [ + true + ] + }, + "readers_can_create_discussions": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_teams": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_view_dependency_insights": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_fork_private_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "advanced_security_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "dependabot_alerts_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "dependabot_security_updates_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "dependency_graph_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "secret_scanning_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "secret_scanning_push_protection_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_custom_link": { + "type": [ + "string", + "null" + ], + "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", + "examples": [ + "https://github.com/test-org/test-repo/blob/main/README.md" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization.", + "examples": [ + false + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description", + "html_url", + "has_organization_projects", + "has_repository_projects", + "public_repos", + "public_gists", + "followers", + "following", + "type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "examples": { + "default-response": { + "value": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "github", + "is_verified": true, + "has_organization_projects": true, + "has_repository_projects": true, + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "html_url": "https://github.com/octocat", + "created_at": "2008-01-14T04:33:35Z", + "type": "Organization", + "total_private_repos": 100, + "owned_private_repos": 100, + "private_gists": 81, + "disk_usage": 10000, + "collaborators": 8, + "billing_email": "mona@github.com", + "plan": { + "name": "Medium", + "space": 400, + "private_repos": 20, + "filled_seats": 4, + "seats": 5 + }, + "default_repository_permission": "read", + "default_repository_branch": "main", + "members_can_create_repositories": true, + "two_factor_requirement_enabled": true, + "members_allowed_repository_creation_type": "all", + "members_can_create_public_repositories": false, + "members_can_create_private_repositories": false, + "members_can_create_internal_repositories": false, + "members_can_create_pages": true, + "members_can_create_public_pages": true, + "members_can_create_private_pages": true, + "members_can_delete_repositories": true, + "members_can_change_repo_visibility": true, + "members_can_invite_outside_collaborators": true, + "members_can_delete_issues": false, + "display_commenter_full_name_setting_enabled": false, + "readers_can_create_discussions": true, + "members_can_create_teams": true, + "members_can_view_dependency_insights": true, + "members_can_fork_private_repositories": false, + "web_commit_signoff_required": false, + "updated_at": "2014-03-03T18:58:10Z", + "deploy_keys_enabled_for_repositories": false, + "dependency_graph_enabled_for_new_repositories": false, + "dependabot_alerts_enabled_for_new_repositories": false, + "dependabot_security_updates_enabled_for_new_repositories": false, + "advanced_security_enabled_for_new_repositories": false, + "secret_scanning_enabled_for_new_repositories": false, + "secret_scanning_push_protection_enabled_for_new_repositories": false, + "secret_scanning_push_protection_custom_link": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md", + "secret_scanning_push_protection_custom_link_enabled": false } } } } - }, - "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" + } + } } } } @@ -63266,20 +63667,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "hosted-runners" + "category": "orgs", + "subcategory": "orgs" } }, "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", + "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/hosted-runners#update-a-github-hosted-runner-for-an-organization" + "url": "https://docs.github.com/rest/orgs/orgs#update-an-organization" }, "parameters": [ { @@ -63290,49 +63691,176 @@ "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, + "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. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.", - "type": "string" + "type": "string", + "description": "The shorthand name of the company." }, - "runner_group_id": { - "description": "The existing runner group to add this runner to.", - "type": "integer" + "description": { + "type": "string", + "description": "The description of the company. The maximum size is 160 characters." }, - "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" + "has_organization_projects": { + "type": "boolean", + "description": "Whether an organization can use organization projects." }, - "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" + "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", + "examples": [ + "\"http://github.blog\"" + ] + }, + "advanced_security_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true + }, + "dependabot_alerts_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true + }, + "dependabot_security_updates_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true + }, + "dependency_graph_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true + }, + "secret_scanning_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true + }, + "secret_scanning_push_protection_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection." + }, + "secret_scanning_push_protection_custom_link": { + "type": "string", + "description": "If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret." + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } } }, "examples": { "default": { "value": { - "name": "My larger runner", - "runner_group_id": 1, - "maximum_runners": 50, - "enable_static_ip": false + "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" } } } @@ -63345,592 +63873,718 @@ "content": { "application/json": { "schema": { - "title": "GitHub-hosted hosted runner", - "description": "A Github-hosted hosted runner.", + "title": "Organization Full", + "description": "Organization Full", "type": "object", "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, "id": { - "description": "The unique identifier of the hosted runner.", "type": "integer", "examples": [ - 5 + 1 ] }, - "name": { - "description": "The name of the hosted runner.", + "node_id": { "type": "string", "examples": [ - "my-github-hosted-runner" + "MDEyOk9yZ2FuaXphdGlvbjE=" ] }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", + "url": { + "type": "string", + "format": "uri", "examples": [ - 2 + "https://api.github.com/orgs/github" ] }, - "image_details": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", - "type": "object", - "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "examples": [ - "ubuntu-20.04" - ] - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "examples": [ - 86 - ] - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "examples": [ - 20.04 - ] - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ] - } + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" ] }, - "machine_size_details": { - "title": "Github-owned VM details.", - "description": "Provides details of a particular machine spec.", - "type": "object", - "properties": { - "id": { - "description": "The ID used for the `size` parameter when creating a new runner.", - "type": "string", - "examples": [ - "8-core" - ] - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "examples": [ - 8 - ] - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "examples": [ - 32 - ] - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "examples": [ - 300 - ] - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" ] }, - "status": { - "description": "The status of the runner.", + "hooks_url": { "type": "string", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ], "examples": [ - "Ready" + "https://api.github.com/orgs/github/hooks" ] }, - "platform": { - "description": "The operating system of the image.", + "issues_url": { "type": "string", "examples": [ - "linux-x64" + "https://api.github.com/orgs/github/issues" ] }, - "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, + "members_url": { + "type": "string", "examples": [ - 5 + "https://api.github.com/orgs/github/members{/member}" ] }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", - "type": "boolean", + "public_members_url": { + "type": "string", "examples": [ - true + "https://api.github.com/orgs/github/public_members{/member}" ] }, - "public_ips": { - "description": "The public IP ranges when public IP is enabled for the hosted runners.", - "type": "array", - "items": { - "title": "Public IP for a GitHub-hosted larger runners.", - "description": "Provides details of Public IP for a GitHub-hosted larger runners", - "type": "object", - "properties": { - "enabled": { - "description": "Whether public IP is enabled.", - "type": "boolean", - "examples": [ - true - ] - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "examples": [ - "20.80.208.150" - ] - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "examples": [ - 28 - ] - } - } - } + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", + "description": { "type": [ "string", "null" ], - "format": "date-time", "examples": [ - "2022-10-09T23:39:01Z" + "A great organization" ] - } - }, - "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 - } + }, + "name": { + "type": "string", + "examples": [ + "github" + ] + }, + "company": { + "type": "string", + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": "string", + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": "string", + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" ], - "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.", + "examples": [ + "github" + ] + }, + "is_verified": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_organization_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_repository_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "public_repos": { "type": "integer", "examples": [ - 5 + 2 ] }, - "name": { - "description": "The name of the hosted runner.", + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "html_url": { "type": "string", + "format": "uri", "examples": [ - "my-github-hosted-runner" + "https://github.com/octocat" ] }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "total_private_repos": { "type": "integer", "examples": [ - 2 + 100 ] }, - "image_details": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", - "type": "object", - "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "examples": [ - "ubuntu-20.04" - ] - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "examples": [ - 86 - ] - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "examples": [ - 20.04 - ] - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ] - } + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 ] }, - "machine_size_details": { - "title": "Github-owned VM details.", - "description": "Provides details of a particular machine spec.", + "private_gists": { + "type": [ + "integer", + "null" + ], + "examples": [ + 81 + ] + }, + "disk_usage": { + "type": [ + "integer", + "null" + ], + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": [ + "integer", + "null" + ], + "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000.", + "examples": [ + 8 + ] + }, + "billing_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "org@example.com" + ] + }, + "plan": { "type": "object", "properties": { - "id": { - "description": "The ID used for the `size` parameter when creating a new runner.", - "type": "string", - "examples": [ - "8-core" - ] + "name": { + "type": "string" }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "examples": [ - 8 - ] + "space": { + "type": "integer" }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "examples": [ - 32 - ] + "private_repos": { + "type": "integer" }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "examples": [ - 300 - ] + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" } }, "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" + "name", + "space", + "private_repos" ] }, - "status": { - "description": "The status of the runner.", - "type": "string", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" + "default_repository_permission": { + "type": [ + "string", + "null" + ] + }, + "default_repository_branch": { + "type": [ + "string", + "null" ], + "description": "The default branch for repositories created in this organization.", "examples": [ - "Ready" + "main" ] }, - "platform": { - "description": "The operating system of the image.", + "members_can_create_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "two_factor_requirement_enabled": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "members_allowed_repository_creation_type": { "type": "string", "examples": [ - "linux-x64" + "all" ] }, - "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, + "members_can_create_public_repositories": { + "type": "boolean", "examples": [ - 5 + true ] }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", + "members_can_create_private_repositories": { "type": "boolean", "examples": [ true ] }, - "public_ips": { - "description": "The public IP ranges when public IP is enabled for the hosted runners.", - "type": "array", - "items": { - "title": "Public IP for a GitHub-hosted larger runners.", - "description": "Provides details of Public IP for a GitHub-hosted larger runners", - "type": "object", - "properties": { - "enabled": { - "description": "Whether public IP is enabled.", - "type": "boolean", - "examples": [ - true - ] - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "examples": [ - "20.80.208.150" - ] - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "examples": [ - 28 - ] - } - } - } + "members_can_create_internal_repositories": { + "type": "boolean", + "examples": [ + true + ] }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", + "members_can_create_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_public_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_delete_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_change_repo_visibility": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_invite_outside_collaborators": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_delete_issues": { + "type": "boolean", + "examples": [ + true + ] + }, + "display_commenter_full_name_setting_enabled": { + "type": "boolean", + "examples": [ + true + ] + }, + "readers_can_create_discussions": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_teams": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_view_dependency_insights": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_fork_private_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "advanced_security_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "dependabot_alerts_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "dependabot_security_updates_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "dependency_graph_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "secret_scanning_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "secret_scanning_push_protection_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_custom_link": { "type": [ "string", "null" ], + "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", + "examples": [ + "https://github.com/test-org/test-repo/blob/main/README.md" + ] + }, + "created_at": { + "type": "string", "format": "date-time", "examples": [ - "2022-10-09T23:39:01Z" + "2008-01-14T04:33:35Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization.", + "examples": [ + false ] } }, "required": [ + "login", + "url", "id", - "name", - "image_details", - "machine_size_details", - "status", - "public_ip_enabled", - "platform" + "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": 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 + "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 }, - "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" + "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": { - "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", + }, + "422": { + "description": "Validation failed", "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" + "oneOf": [ + { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + }, + { + "title": "Validation Error Simple", + "description": "Validation Error Simple", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + } } } - }, - "required": [ - "include_claim_keys" ] - }, - "examples": { - "default": { - "value": { - "include_claim_keys": [ - "repo", - "context" - ] + } + } + } + }, + "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" } } } @@ -63939,21 +64593,22 @@ } }, "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "oidc" + "category": "orgs", + "subcategory": "orgs" } }, - "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.", + "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": [ - "oidc" + "orgs" ], - "operationId": "oidc/update-oidc-custom-sub-template-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization" + "url": "https://docs.github.com/rest/orgs/orgs#delete-an-organization" }, "parameters": [ { @@ -63966,51 +64621,13 @@ } } ], - "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", + "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": { @@ -64074,24 +64691,24 @@ } }, "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [], - "category": "actions", - "subcategory": "oidc" + "category": "orgs", + "subcategory": "orgs" } } }, - "/orgs/{org}/actions/permissions": { + "/orgs/{org}/actions/cache/usage": { "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", + "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/permissions#get-github-actions-permissions-for-an-organization" + "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-an-organization" }, "parameters": [ { @@ -64112,144 +64729,59 @@ "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" - ] + "total_active_caches_count": { + "type": "integer", + "description": "The count of active caches across all repositories of an enterprise or an organization." }, - "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`." + "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": [ - "enabled_repositories" + "total_active_caches_count", + "total_active_caches_size_in_bytes" ] }, "examples": { "default": { "value": { - "enabled_repositories": "all", - "allowed_actions": "selected", - "selected_actions_url": "https://api.github.com/organizations/42/actions/permissions/selected-actions" + "total_active_caches_size_in_bytes": 3344284, + "total_active_caches_count": 5 } } } } - } - } - }, - "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" - } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" } } } } }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "permissions" + "subcategory": "cache" } } }, - "/orgs/{org}/actions/permissions/repositories": { + "/orgs/{org}/actions/cache/usage-by-repository": { "get": { - "summary": "List selected repositories enabled for GitHub Actions in an organization", - "description": "Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/list-selected-repositories-enabled-github-actions-organization", + "summary": "List repositories 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/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization" + "url": "https://docs.github.com/rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization" }, "parameters": [ { @@ -64289,961 +64821,352 @@ "type": "object", "required": [ "total_count", - "repositories" + "repository_cache_usages" ], "properties": { "total_count": { - "type": "number" + "type": "integer" }, - "repositories": { + "repository_cache_usages": { "type": "array", "items": { - "title": "Repository", - "description": "A repository on GitHub.", + "title": "Actions Cache Usage by repository", + "description": "GitHub Actions Cache Usage by repository.", "type": "object", "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { + "full_name": { + "description": "The repository owner and name for the cache usage being shown.", "type": "string", "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "octo-org/Hello-World" ] }, - "name": { - "description": "The name of the repository.", - "type": "string", + "active_caches_size_in_bytes": { + "description": "The sum of the size in bytes of all the active cache items in the repository.", + "type": "integer", "examples": [ - "Team Environment" + 2322142 ] }, - "full_name": { - "type": "string", + "active_caches_count": { + "description": "The number of active caches in the repository.", + "type": "integer", "examples": [ - "octocat/Hello-World" + 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", + "examples": [ + 5 ] }, - "license": { + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "examples": [ + "my-github-hosted-runner" + ] + }, + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "examples": [ + 2 + ] + }, + "image_details": { "anyOf": [ { "type": "null" }, { - "title": "License Simple", - "description": "License Simple", + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", "type": "object", "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", "type": "string", "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" + "ubuntu-20.04" ] }, - "spdx_id": { - "type": [ - "string", - "null" - ], + "size_gb": { + "description": "Image size in GB.", + "type": "integer", "examples": [ - "MIT" + 86 ] }, - "node_id": { + "display_name": { + "description": "Display name for this image.", "type": "string", "examples": [ - "MDc6TGljZW5zZW1pdA==" + 20.04 ] }, - "html_url": { + "source": { + "description": "The image provider.", "type": "string", - "format": "uri" + "enum": [ + "github", + "partner", + "custom" + ] } }, "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" + "id", + "size_gb", + "display_name", + "source" ] } ] }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", + "machine_size_details": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { + "description": "The ID used for the `size` parameter when creating a new runner.", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "8-core" ] }, - "type": { - "type": "string", + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", "examples": [ - "User" + 8 ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", "examples": [ - "\"2020-07-09T00:17:55Z\"" + 32 ] }, - "user_view_type": { - "type": "string", + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", "examples": [ - "public" + 300 ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" + "cpu_cores", + "memory_gb", + "storage_gb" ] }, - "svn_url": { + "status": { + "description": "The status of the runner.", "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", "examples": [ - 108 + "Ready" ] }, - "default_branch": { - "description": "The default branch of the repository.", + "platform": { + "description": "The operating system of the image.", "type": "string", "examples": [ - "master" + "linux-x64" ] }, - "open_issues_count": { + "maximum_runners": { + "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", "type": "integer", + "default": 10, "examples": [ - 0 + 5 ] }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", "type": "boolean", "examples": [ true ] }, - "topics": { + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", "type": "array", "items": { - "type": "string" + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", + "type": "object", + "properties": { + "enabled": { + "description": "Whether public IP is enabled.", + "type": "boolean", + "examples": [ + true + ] + }, + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "examples": [ + "20.80.208.150" + ] + }, + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "examples": [ + 28 + ] + } + } } }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", "type": [ "string", "null" ], "format": "date-time", "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" + "2022-10-09T23:39:01Z" ] - }, - "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" + "image_details", + "machine_size_details", + "status", + "public_ip_enabled", + "platform" ] } } @@ -65252,156 +65175,89 @@ "examples": { "default": { "value": { - "total_count": 1, - "repositories": [ + "total_count": 2, + "runners": [ { - "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 + "id": 5, + "name": "My hosted ubuntu runner", + "runner_group_id": 2, + "platform": "linux-x64", + "image": { + "id": "ubuntu-20.04", + "size": 86 }, - "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" + "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 + } ], - "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 + "last_active_on": "2022-10-09T23:39:01Z" + }, + { + "id": 7, + "name": "My hosted Windows runner", + "runner_group_id": 2, + "platform": "win-x64", + "image": { + "id": "windows-latest", + "size": 256 }, - "allow_rebase_merge": 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" + "machine_size_details": { + "id": "8-core", + "cpu_cores": 8, + "memory_gb": 32, + "storage_gb": 300 }, - "forks": 1, - "open_issues": 1, - "watchers": 1 + "status": "Ready", + "maximum_runners": 20, + "public_ip_enabled": false, + "public_ips": [], + "last_active_on": "2023-04-26T15:23:37Z" } ] } } } } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } } } }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "permissions" + "subcategory": "hosted-runners" } }, - "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", + "post": { + "summary": "Create a GitHub-hosted runner for an organization", + "description": "Creates a GitHub-hosted runner for an organization.\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "operationId": "actions/create-hosted-runner-for-org", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization" }, "parameters": [ { @@ -65414,11 +65270,6 @@ } } ], - "responses": { - "204": { - "description": "Response" - } - }, "requestBody": { "required": true, "content": { @@ -65426,26 +65277,312 @@ "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." + "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": [ - "selected_repository_ids" + "name", + "image", + "size", + "runner_group_id" ] }, "examples": { "default": { "value": { - "selected_repository_ids": [ - 32, - 42 - ] + "name": "My Hosted runner", + "image": { + "id": "ubuntu-latest", + "source": "github" + }, + "runner_group_id": 1, + "size": "4-core", + "maximum_runners": 50, + "enable_static_ip": false + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the hosted runner.", + "type": "integer", + "examples": [ + 5 + ] + }, + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "examples": [ + "my-github-hosted-runner" + ] + }, + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "examples": [ + 2 + ] + }, + "image_details": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "examples": [ + "ubuntu-20.04" + ] + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 20.04 + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ] + } + ] + }, + "machine_size_details": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", + "type": "object", + "properties": { + "id": { + "description": "The ID used for the `size` parameter when creating a new runner.", + "type": "string", + "examples": [ + "8-core" + ] + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "examples": [ + 8 + ] + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "examples": [ + 32 + ] + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "examples": [ + 300 + ] + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ], + "examples": [ + "Ready" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] + }, + "maximum_runners": { + "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", + "type": "integer", + "default": 10, + "examples": [ + 5 + ] + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "examples": [ + true + ] + }, + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", + "type": "array", + "items": { + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", + "type": "object", + "properties": { + "enabled": { + "description": "Whether public IP is enabled.", + "type": "boolean", + "examples": [ + true + ] + }, + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "examples": [ + "20.80.208.150" + ] + }, + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "examples": [ + 28 + ] + } + } + } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2022-10-09T23:39:01Z" + ] + } + }, + "required": [ + "id", + "name", + "image_details", + "machine_size_details", + "status", + "public_ip_enabled", + "platform" + ] + }, + "examples": { + "default": { + "value": { + "id": 5, + "name": "My hosted ubuntu runner", + "runner_group_id": 2, + "platform": "linux-x64", + "image": { + "id": "ubuntu-20.04", + "size": 86 + }, + "machine_size_details": { + "id": "4-core", + "cpu_cores": 4, + "memory_gb": 16, + "storage_gb": 150 + }, + "status": "Ready", + "maximum_runners": 10, + "public_ip_enabled": true, + "public_ips": [ + { + "enabled": true, + "prefix": "20.80.208.150", + "length": 31 + } + ], + "last_active_on": "2022-10-09T23:39:01Z" + } } } } @@ -65456,21 +65593,21 @@ "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", - "subcategory": "permissions" + "subcategory": "hosted-runners" } } }, - "/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", + "/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/permissions#enable-a-selected-repository-for-github-actions-in-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization" }, "parameters": [ { @@ -65481,39 +65618,113 @@ "schema": { "type": "string" } - }, - { - "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", + "examples": [ + "ubuntu-20.04" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 20.04 + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "platform", + "size_gb", + "display_name", + "source" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "id": "ubuntu-20.04", + "platform": "linux-x64", + "size_gb": 86, + "display_name": "20.04", + "source": "github" + } + } + } + } + } } }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "permissions" + "subcategory": "hosted-runners" } - }, - "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", + } + }, + "/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/permissions#disable-a-selected-repository-for-github-actions-in-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization" }, "parameters": [ { @@ -65524,41 +65735,113 @@ "schema": { "type": "string" } - }, - { - "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", + "examples": [ + "ubuntu-20.04" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 20.04 + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "platform", + "size_gb", + "display_name", + "source" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "id": "ubuntu-20.04", + "platform": "linux-x64", + "size_gb": 86, + "display_name": "20.04", + "source": "github" + } + } + } + } + } } }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "permissions" + "subcategory": "hosted-runners" } } }, - "/orgs/{org}/actions/permissions/selected-actions": { + "/orgs/{org}/actions/hosted-runners/limits": { "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", + "summary": "Get limits on GitHub-hosted runners for an organization", + "description": "Get the GitHub-hosted runners limits for an organization.", + "operationId": "actions/get-hosted-runners-limits-for-org", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-organization" }, "parameters": [ { @@ -65579,32 +65862,43 @@ "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" - } + "public_ips": { + "title": "Static public IP Limits for GitHub-hosted Hosted Runners.", + "description": "Provides details of static public IP limits for GitHub-hosted Hosted Runners", + "type": "object", + "properties": { + "maximum": { + "type": "integer", + "description": "The maximum number of static public IP addresses that can be used for Hosted Runners.", + "examples": [ + 50 + ] + }, + "current_usage": { + "type": "integer", + "description": "The current number of static public IP addresses in use by Hosted Runners.", + "examples": [ + 17 + ] + } + }, + "required": [ + "maximum", + "current_usage" + ] } - } + }, + "required": [ + "public_ips" + ] }, "examples": { "default": { "value": { - "github_owned_allowed": true, - "verified_allowed": false, - "patterns_allowed": [ - "monalisa/octocat@*", - "docker/*" - ] + "public_ips": { + "current_usage": 17, + "maximum": 50 + } } } } @@ -65613,22 +65907,24 @@ } }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "permissions" + "subcategory": "hosted-runners" } - }, - "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", + } + }, + "/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/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization" }, "parameters": [ { @@ -65642,43 +65938,74 @@ } ], "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" + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "machine_specs" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "machine_specs": { + "type": "array", + "items": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", + "type": "object", + "properties": { + "id": { + "description": "The ID used for the `size` parameter when creating a new runner.", + "type": "string", + "examples": [ + "8-core" + ] + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "examples": [ + 8 + ] + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "examples": [ + 32 + ] + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "examples": [ + 300 + ] + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + } } } - } - }, - "examples": { - "selected_actions": { - "value": { - "github_owned_allowed": true, - "verified_allowed": false, - "patterns_allowed": [ - "monalisa/octocat@*", - "docker/*" - ] + }, + "examples": { + "default": { + "value": { + "id": "4-core", + "cpu_cores": 4, + "memory_gb": 16, + "storage_gb": 150 + } } } } @@ -65686,24 +66013,24 @@ } }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "permissions" + "subcategory": "hosted-runners" } } }, - "/orgs/{org}/actions/permissions/workflow": { + "/orgs/{org}/actions/hosted-runners/platforms": { "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.", + "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" ], - "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" + "url": "https://docs.github.com/rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-organization" }, "parameters": [ { @@ -65723,31 +66050,30 @@ "application/json": { "schema": { "type": "object", + "required": [ + "total_count", + "platforms" + ], "properties": { - "default_workflow_permissions": { - "type": "string", - "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", - "enum": [ - "read", - "write" - ] + "total_count": { + "type": "integer" }, - "can_approve_pull_request_reviews": { - "type": "boolean", - "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk." + "platforms": { + "type": "array", + "items": { + "type": "string" + } } - }, - "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 + "total_count": 1, + "platforms": [ + "linux-x64", + "win-x64" + ] } } } @@ -65759,19 +66085,21 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "permissions" + "subcategory": "hosted-runners" } - }, - "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.", + } + }, + "/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/set-github-actions-default-workflow-permissions-organization", + "operationId": "actions/get-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization" }, "parameters": [ { @@ -65781,102 +66109,15 @@ "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" + } + }, + { + "name": "hosted_runner_id", + "description": "Unique identifier of the GitHub-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" } } ], @@ -65886,161 +66127,272 @@ "content": { "application/json": { "schema": { + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", "type": "object", - "required": [ - "total_count", - "runner_groups" - ], "properties": { - "total_count": { - "type": "number" + "id": { + "description": "The unique identifier of the hosted runner.", + "type": "integer", + "examples": [ + 5 + ] }, - "runner_groups": { + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "examples": [ + "my-github-hosted-runner" + ] + }, + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "examples": [ + 2 + ] + }, + "image_details": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "examples": [ + "ubuntu-20.04" + ] + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 20.04 + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ] + } + ] + }, + "machine_size_details": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", + "type": "object", + "properties": { + "id": { + "description": "The ID used for the `size` parameter when creating a new runner.", + "type": "string", + "examples": [ + "8-core" + ] + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "examples": [ + 8 + ] + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "examples": [ + 32 + ] + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "examples": [ + 300 + ] + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ], + "examples": [ + "Ready" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] + }, + "maximum_runners": { + "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", + "type": "integer", + "default": 10, + "examples": [ + 5 + ] + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "examples": [ + true + ] + }, + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", "type": "array", "items": { + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", "type": "object", "properties": { - "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.", + "enabled": { + "description": "Whether public IP is enabled.", "type": "boolean", - "default": false + "examples": [ + true + ] }, - "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 + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "examples": [ + "20.80.208.150" + ] }, - "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.", - "examples": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - ] - } + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "examples": [ + 28 + ] } - }, - "required": [ - "id", - "name", - "visibility", - "default", - "runners_url", - "inherited", - "allows_public_repositories" - ] + } } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2022-10-09T23:39:01Z" + ] } - } + }, + "required": [ + "id", + "name", + "image_details", + "machine_size_details", + "status", + "public_ip_enabled", + "platform" + ] }, "examples": { "default": { "value": { - "total_count": 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": 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": 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 + "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" } }, - "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", + "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#create-a-self-hosted-runner-group-for-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization" }, "parameters": [ { @@ -66051,6 +66403,15 @@ "schema": { "type": "string" } + }, + { + "name": "hosted_runner_id", + "description": "Unique identifier of the GitHub-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "requestBody": { @@ -66061,78 +66422,30 @@ "type": "object", "properties": { "name": { - "description": "Name of the runner group.", + "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" }, - "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 + "runner_group_id": { + "description": "The existing runner group to add this runner to.", + "type": "integer" }, - "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.", - "examples": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - ] - } + "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" }, - "network_configuration_id": { - "description": "The identifier of a hosted compute network configuration.", - "type": "string" + "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" } - }, - "required": [ - "name" - ] + } }, "examples": { "default": { "value": { - "name": "Expensive hardware runners", - "visibility": "selected", - "selected_repository_ids": [ - 32, - 91 - ], - "runners": [ - 9, - 2 - ] + "name": "My larger runner", + "runner_group_id": 1, + "maximum_runners": 50, + "enable_static_ip": false } } } @@ -66140,98 +66453,245 @@ } }, "responses": { - "201": { + "200": { "description": "Response", "content": { "application/json": { "schema": { + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", "type": "object", "properties": { "id": { - "type": "number" + "description": "The unique identifier of the hosted runner.", + "type": "integer", + "examples": [ + 5 + ] }, "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" + "description": "The name of the hosted runner.", + "type": "string", + "examples": [ + "my-github-hosted-runner" + ] }, - "hosted_runners_url": { - "type": "string" + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "examples": [ + 2 + ] }, - "network_configuration_id": { - "description": "The identifier of a hosted compute network configuration.", - "type": "string" + "image_details": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "examples": [ + "ubuntu-20.04" + ] + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 20.04 + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ] + } + ] }, - "inherited": { - "type": "boolean" + "machine_size_details": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", + "type": "object", + "properties": { + "id": { + "description": "The ID used for the `size` parameter when creating a new runner.", + "type": "string", + "examples": [ + "8-core" + ] + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "examples": [ + 8 + ] + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "examples": [ + 32 + ] + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "examples": [ + 300 + ] + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] }, - "inherited_allows_public_repositories": { - "type": "boolean" + "status": { + "description": "The status of the runner.", + "type": "string", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ], + "examples": [ + "Ready" + ] }, - "allows_public_repositories": { - "type": "boolean" + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] }, - "workflow_restrictions_read_only": { - "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", - "type": "boolean", - "default": false + "maximum_runners": { + "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", + "type": "integer", + "default": 10, + "examples": [ + 5 + ] }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", "type": "boolean", - "default": false + "examples": [ + 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`.", + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", "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.", - "examples": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - ] + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", + "type": "object", + "properties": { + "enabled": { + "description": "Whether public IP is enabled.", + "type": "boolean", + "examples": [ + true + ] + }, + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "examples": [ + "20.80.208.150" + ] + }, + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "examples": [ + 28 + ] + } + } } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2022-10-09T23:39:01Z" + ] } }, "required": [ "id", "name", - "visibility", - "default", - "runners_url", - "inherited", - "allows_public_repositories" + "image_details", + "machine_size_details", + "status", + "public_ip_enabled", + "platform" ] }, "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" + "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 + } ], - "workflow_restrictions_read_only": false + "last_active_on": "2022-10-09T23:39:01Z" } } } @@ -66243,21 +66703,19 @@ "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "hosted-runners" } - } - }, - "/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", + }, + "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/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization" }, "parameters": [ { @@ -66270,8 +66728,8 @@ } }, { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", + "name": "hosted_runner_id", + "description": "Unique identifier of the GitHub-hosted runner.", "in": "path", "required": true, "schema": { @@ -66280,98 +66738,245 @@ } ], "responses": { - "200": { + "202": { "description": "Response", "content": { "application/json": { "schema": { + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", "type": "object", "properties": { "id": { - "type": "number" + "description": "The unique identifier of the hosted runner.", + "type": "integer", + "examples": [ + 5 + ] }, "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" + "description": "The name of the hosted runner.", + "type": "string", + "examples": [ + "my-github-hosted-runner" + ] }, - "hosted_runners_url": { - "type": "string" + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "examples": [ + 2 + ] }, - "network_configuration_id": { - "description": "The identifier of a hosted compute network configuration.", - "type": "string" + "image_details": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "examples": [ + "ubuntu-20.04" + ] + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 20.04 + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ] + } + ] }, - "inherited": { - "type": "boolean" + "machine_size_details": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", + "type": "object", + "properties": { + "id": { + "description": "The ID used for the `size` parameter when creating a new runner.", + "type": "string", + "examples": [ + "8-core" + ] + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "examples": [ + 8 + ] + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "examples": [ + 32 + ] + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "examples": [ + 300 + ] + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] }, - "inherited_allows_public_repositories": { - "type": "boolean" + "status": { + "description": "The status of the runner.", + "type": "string", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ], + "examples": [ + "Ready" + ] }, - "allows_public_repositories": { - "type": "boolean" + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] }, - "workflow_restrictions_read_only": { - "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", - "type": "boolean", - "default": false + "maximum_runners": { + "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", + "type": "integer", + "default": 10, + "examples": [ + 5 + ] }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", "type": "boolean", - "default": false + "examples": [ + 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`.", + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", "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.", - "examples": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - ] + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", + "type": "object", + "properties": { + "enabled": { + "description": "Whether public IP is enabled.", + "type": "boolean", + "examples": [ + true + ] + }, + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "examples": [ + "20.80.208.150" + ] + }, + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "examples": [ + 28 + ] + } + } } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2022-10-09T23:39:01Z" + ] } }, "required": [ "id", "name", - "visibility", - "default", - "runners_url", - "inherited", - "allows_public_repositories" + "image_details", + "machine_size_details", + "status", + "public_ip_enabled", + "platform" ] }, "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" + "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 + } ], - "workflow_restrictions_read_only": false + "last_active_on": "2022-10-09T23:39:01Z" } } } @@ -66380,22 +66985,24 @@ } }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": false, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "hosted-runners" } - }, - "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", + } + }, + "/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": [ - "actions" + "oidc" ], + "operationId": "oidc/get-oidc-custom-sub-template-for-org", "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/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization" }, "parameters": [ { @@ -66406,14 +67013,69 @@ "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": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], @@ -66422,59 +67084,29 @@ "content": { "application/json": { "schema": { + "title": "Actions OIDC Subject customization", + "description": "Actions OIDC Subject customization", "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`.", + "include_claim_keys": { + "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.", "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.", - "examples": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - ] + "type": "string" } - }, - "network_configuration_id": { - "description": "The identifier of a hosted compute network configuration.", - "type": [ - "string", - "null" - ] } }, "required": [ - "name" + "include_claim_keys" ] }, "examples": { "default": { "value": { - "name": "Expensive hardware runners", - "visibility": "selected" + "include_claim_keys": [ + "repo", + "context" + ] } } } @@ -66482,98 +67114,154 @@ } }, "responses": { - "200": { - "description": "Response", + "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": { - "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": { + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "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" + "url": { + "type": "string" }, - "allows_public_repositories": { - "type": "boolean" + "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" + ] }, - "workflow_restrictions_read_only": { - "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", - "type": "boolean", - "default": false + "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`." }, - "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 + "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_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.", - "examples": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - ] - } + "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": [ - "id", - "name", - "visibility", - "default", - "runners_url", - "inherited", - "allows_public_repositories" + "enabled_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 + "enabled_repositories": "all", + "allowed_actions": "selected", + "selected_actions_url": "https://api.github.com/organizations/42/actions/permissions/selected-actions" } } } @@ -66585,19 +67273,19 @@ "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "permissions" } }, - "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", + "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/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-an-organization" }, "parameters": [ { @@ -66608,15 +67296,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": { @@ -66624,25 +67303,66 @@ "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-runner-groups" + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/runner-groups/{runner_group_id}/hosted-runners": { + "/orgs/{org}/actions/permissions/repositories": { "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": "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/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization" }, "parameters": [ { @@ -66654,15 +67374,6 @@ "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).\"", @@ -66691,396 +67402,134 @@ "type": "object", "required": [ "total_count", - "runners" + "repositories" ], "properties": { "total_count": { "type": "number" }, - "runners": { + "repositories": { "type": "array", "items": { - "title": "GitHub-hosted hosted runner", - "description": "A Github-hosted hosted runner.", + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", "properties": { "id": { - "description": "The unique identifier of the hosted runner.", + "description": "Unique identifier of the repository", "type": "integer", + "format": "int64", "examples": [ - 5 + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { - "description": "The name of the hosted runner.", + "description": "The name of the repository.", "type": "string", "examples": [ - "my-github-hosted-runner" + "Team Environment" ] }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", + "full_name": { + "type": "string", "examples": [ - 2 + "octocat/Hello-World" ] }, - "image_details": { + "license": { "anyOf": [ { "type": "null" }, { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", + "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", "examples": [ - "ubuntu-20.04" + "mit" ] }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", + "name": { + "type": "string", "examples": [ - 86 + "MIT License" ] }, - "display_name": { - "description": "Display name for this image.", - "type": "string", + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", "examples": [ - 20.04 + "https://api.github.com/licenses/mit" ] }, - "source": { - "description": "The image provider.", + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { "type": "string", - "enum": [ - "github", - "partner", - "custom" + "examples": [ + "MDc6TGljZW5zZW1pdA==" ] + }, + "html_url": { + "type": "string", + "format": "uri" } }, "required": [ - "id", - "size_gb", - "display_name", - "source" + "key", + "name", + "url", + "spdx_id", + "node_id" ] } ] }, - "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.", - "type": "string", - "examples": [ - "8-core" - ] + "admin": { + "type": "boolean" }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "examples": [ - 8 - ] + "pull": { + "type": "boolean" }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "examples": [ - 32 - ] + "triage": { + "type": "boolean" }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "examples": [ - 300 - ] + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" } }, "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ], - "examples": [ - "Ready" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "examples": [ - "linux-x64" - ] - }, - "maximum_runners": { - "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", - "type": "integer", - "default": 10, - "examples": [ - 5 - ] - }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", - "type": "boolean", - "examples": [ - true - ] - }, - "public_ips": { - "description": "The public IP ranges when public IP is enabled for the hosted runners.", - "type": "array", - "items": { - "title": "Public IP for a GitHub-hosted larger runners.", - "description": "Provides details of Public IP for a GitHub-hosted larger runners", - "type": "object", - "properties": { - "enabled": { - "description": "Whether public IP is enabled.", - "type": "boolean", - "examples": [ - true - ] - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "examples": [ - "20.80.208.150" - ] - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "examples": [ - 28 - ] - } - } - } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2022-10-09T23:39:01Z" - ] - } - }, - "required": [ - "id", - "name", - "image_details", - "machine_size_details", - "status", - "public_ip_enabled", - "platform" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "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", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" + "admin", + "pull", + "push" ] }, "owner": { @@ -67252,6 +67701,8 @@ ] }, "private": { + "description": "Whether the repository is private or public.", + "default": false, "type": "boolean" }, "html_url": { @@ -67388,7 +67839,10 @@ ] }, "git_url": { - "type": "string" + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] }, "issue_comment_url": { "type": "string", @@ -67459,7 +67913,10 @@ ] }, "ssh_url": { - "type": "string" + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] }, "stargazers_url": { "type": "string", @@ -67509,12 +67966,19 @@ ] }, "clone_url": { - "type": "string" + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] }, "mirror_url": { "type": [ "string", "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { @@ -67525,12 +67989,20 @@ ] }, "svn_url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] }, "homepage": { "type": [ "string", "null" + ], + "format": "uri", + "examples": [ + "https://github.com" ] }, "language": { @@ -67540,26 +68012,50 @@ ] }, "forks_count": { - "type": "integer" + "type": "integer", + "examples": [ + 9 + ] }, "stargazers_count": { - "type": "integer" + "type": "integer", + "examples": [ + 80 + ] }, "watchers_count": { - "type": "integer" + "type": "integer", + "examples": [ + 80 + ] }, "size": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" + "type": "integer", + "examples": [ + 108 + ] }, "default_branch": { - "type": "string" + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] }, "open_issues_count": { - "type": "integer" + "type": "integer", + "examples": [ + 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", + "examples": [ + true + ] }, "topics": { "type": "array", @@ -67568,30 +68064,61 @@ } }, "has_issues": { - "type": "boolean" + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_projects": { - "type": "boolean" + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_wiki": { - "type": "boolean" + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_pages": { "type": "boolean" }, "has_downloads": { - "type": "boolean" + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] }, "has_discussions": { - "type": "boolean" + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] }, "archived": { + "description": "Whether the repository is archived.", + "default": false, "type": "boolean" }, "disabled": { - "type": "boolean" + "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": { @@ -67624,238 +68151,136 @@ "2011-01-26T19:14:43Z" ] }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", "examples": [ - "admin" + true ] }, "temp_clone_token": { "type": "string" }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, - "network_count": { - "type": "integer" + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# 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", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer", + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", "examples": [ - 0 + false ] }, - "open_issues": { - "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", "examples": [ - 0 + false ] }, - "watchers": { - "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 + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", "examples": [ - 0 + true ] }, "allow_forking": { + "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { - "type": "boolean", + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", "examples": [ - false + "\"2020-07-09T00:17:42Z\"" ] }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], + "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": { - "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": [ @@ -67904,7 +68329,34 @@ "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" ] } } @@ -68017,132 +68469,13 @@ "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 - }, + "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": { @@ -68150,7 +68483,8 @@ "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==" + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://github.com/licenses/mit" }, "forks": 1, "open_issues": 1, @@ -68168,19 +68502,19 @@ "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "permissions" } }, "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", + "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/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization" }, "parameters": [ { @@ -68191,17 +68525,13 @@ "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" + } + }, "requestBody": { "required": true, "content": { @@ -68210,7 +68540,7 @@ "type": "object", "properties": { "selected_repository_ids": { - "description": "List of repository IDs that can access the runner group.", + "description": "List of repository IDs to enable for GitHub Actions.", "type": "array", "items": { "type": "integer", @@ -68227,7 +68557,7 @@ "value": { "selected_repository_ids": [ 32, - 91 + 42 ] } } @@ -68235,30 +68565,25 @@ } } }, - "responses": { - "204": { - "description": "Response" - } - }, "x-github": { "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": { + "/orgs/{org}/actions/permissions/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", + "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/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization" }, "parameters": [ { @@ -68270,15 +68595,6 @@ "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.", @@ -68298,19 +68614,19 @@ "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "permissions" } }, "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", + "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/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization" }, "parameters": [ { @@ -68322,15 +68638,6 @@ "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.", @@ -68350,21 +68657,21 @@ "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": { + "/orgs/{org}/actions/permissions/selected-actions": { "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 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/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization" }, "parameters": [ { @@ -68375,33 +68682,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": { @@ -68411,100 +68691,20 @@ "application/json": { "schema": { "type": "object", - "required": [ - "total_count", - "runners" - ], "properties": { - "total_count": { - "type": "number" + "github_owned_allowed": { + "type": "boolean", + "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." }, - "runners": { + "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": { - "title": "Self hosted runners", - "description": "A self hosted runner", - "type": "object", - "properties": { - "id": { - "description": "The ID of the runner.", - "type": "integer", - "examples": [ - 5 - ] - }, - "runner_group_id": { - "description": "The ID of the runner group.", - "type": "integer", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the runner.", - "type": "string", - "examples": [ - "iMac" - ] - }, - "os": { - "description": "The Operating System of the runner.", - "type": "string", - "examples": [ - "macos" - ] - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "examples": [ - "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" - ] + "type": "string" } } } @@ -68512,76 +68712,16 @@ "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" - } - ] - } + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" ] } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } } } }, @@ -68589,19 +68729,19 @@ "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "permissions" } }, "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", + "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/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization" }, "parameters": [ { @@ -68612,43 +68752,45 @@ "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" + } + }, "requestBody": { - "required": true, + "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { - "runners": { - "description": "List of runner IDs to add to the runner group.", + "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": "integer", - "description": "Unique identifier of the runner." + "type": "string" } } - }, - "required": [ - "runners" - ] + } }, "examples": { - "default": { + "selected_actions": { "value": { - "runners": [ - 9, - 2 + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" ] } } @@ -68656,30 +68798,25 @@ } } }, - "responses": { - "204": { - "description": "Response" - } - }, "x-github": { "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "permissions" } } }, - "/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/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/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-an-organization" }, "parameters": [ { @@ -68690,48 +68827,64 @@ "schema": { "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.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { - "204": { - "description": "Response" + "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": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "permissions" } }, - "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", + "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/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-an-organization" }, "parameters": [ { @@ -68742,60 +68895,67 @@ "schema": { "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.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { "204": { - "description": "Response" + "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": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/runners": { + "/orgs/{org}/actions/runner-groups": { "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.", + "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" ], - "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/self-hosted-runner-groups#list-self-hosted-runner-groups-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.", @@ -68822,6 +68982,15 @@ "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": { @@ -68833,97 +69002,82 @@ "type": "object", "required": [ "total_count", - "runners" + "runner_groups" ], "properties": { "total_count": { - "type": "integer" + "type": "number" }, - "runners": { + "runner_groups": { "type": "array", "items": { - "title": "Self hosted runners", - "description": "A self hosted runner", "type": "object", "properties": { "id": { - "description": "The ID of the runner.", - "type": "integer", - "examples": [ - 5 - ] - }, - "runner_group_id": { - "description": "The ID of the runner group.", - "type": "integer", - "examples": [ - 1 - ] + "type": "number" }, "name": { - "description": "The name of the runner.", - "type": "string", - "examples": [ - "iMac" - ] + "type": "string" }, - "os": { - "description": "The Operating System of the runner.", - "type": "string", - "examples": [ - "macos" - ] + "visibility": { + "type": "string" }, - "status": { - "description": "The status of the runner.", - "type": "string", - "examples": [ - "online" - ] + "default": { + "type": "boolean" }, - "busy": { + "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" }, - "labels": { + "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": { - "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" + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "examples": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@main" ] } - }, - "ephemeral": { - "type": "boolean" } }, "required": [ "id", "name", - "os", - "status", - "busy", - "labels" + "visibility", + "default", + "runners_url", + "inherited", + "allows_public_repositories" ] } } @@ -68932,98 +69086,291 @@ "examples": { "default": { "value": { - "total_count": 2, - "runners": [ + "total_count": 3, + "runner_groups": [ { - "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": 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": 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": 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 } ] } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", + } + } + }, + "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.", + "examples": [ + "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": "string" + "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.", + "examples": [ + "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": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "self-hosted-runner-groups" } } }, - "/orgs/{org}/actions/runners/downloads": { + "/orgs/{org}/actions/runner-groups/{runner_group_id}": { "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 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" ], - "operationId": "actions/list-runner-applications-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/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization" }, "parameters": [ { @@ -69034,6 +69381,15 @@ "schema": { "type": "string" } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "responses": { @@ -69042,74 +69398,94 @@ "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": { - "type": "string" - } + "type": "object", + "properties": { + "id": { + "type": "number" }, - "required": [ - "os", - "architecture", - "download_url", - "filename" - ] - } + "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.", + "examples": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + ] + } + } + }, + "required": [ + "id", + "name", + "visibility", + "default", + "runners_url", + "inherited", + "allows_public_repositories" + ] }, "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": { + "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 + } } } } @@ -69117,24 +69493,22 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "self-hosted-runner-groups" } - } - }, - "/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.", + }, + "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" ], - "operationId": "actions/generate-runner-jitconfig-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/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization" }, "parameters": [ { @@ -69145,6 +69519,15 @@ "schema": { "type": "string" } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "requestBody": { @@ -69153,48 +69536,58 @@ "application/json": { "schema": { "type": "object", - "required": [ - "name", - "runner_group_id", - "labels" - ], "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", - "description": "The name of the new runner." + "enum": [ + "selected", + "all", + "private" + ] }, - "runner_group_id": { - "type": "integer", - "description": "The ID of the runner group to register the runner to." + "allows_public_repositories": { + "description": "Whether the runner group can be used by `public` repositories.", + "type": "boolean", + "default": false }, - "labels": { + "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", - "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." + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "examples": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + ] + } }, - "work_folder": { - "type": "string", - "description": "The working directory to be used for job execution, relative to the runner install directory.", - "default": "_work" + "network_configuration_id": { + "description": "The identifier of a hosted compute network configuration.", + "type": [ + "string", + "null" + ] } - } + }, + "required": [ + "name" + ] }, "examples": { "default": { "value": { - "name": "New runner", - "runner_group_id": 1, - "labels": [ - "self-hosted", - "X64", - "macOS", - "no-gpu" - ], - "work_folder": "_work" + "name": "Expensive hardware runners", + "visibility": "selected" } } } @@ -69202,223 +69595,98 @@ } }, "responses": { - "201": { + "200": { "description": "Response", "content": { "application/json": { "schema": { "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", - "examples": [ - 5 - ] - }, - "runner_group_id": { - "description": "The ID of the runner group.", - "type": "integer", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the runner.", - "type": "string", - "examples": [ - "iMac" - ] - }, - "os": { - "description": "The Operating System of the runner.", - "type": "string", - "examples": [ - "macos" - ] - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "examples": [ - "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" - ] + "id": { + "type": "number" }, - "encoded_jit_config": { - "type": "string", - "description": "The base64 encoded runner configuration." - } - } - }, - "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" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { + "name": { "type": "string" }, - "documentation_url": { + "visibility": { "type": "string" }, - "url": { + "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" }, - "status": { + "runners_url": { "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": { + }, + "hosted_runners_url": { "type": "string" }, - "documentation_url": { + "network_configuration_id": { + "description": "The identifier of a hosted compute network configuration.", "type": "string" }, - "errors": { + "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" + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "examples": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + ] } } - } - } - } - } - }, - "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" + }, + "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 } } } @@ -69427,24 +69695,67 @@ } }, "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-runners" + "subcategory": "self-hosted-runner-groups" } } }, - "/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/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" ], - "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/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization" }, "parameters": [ { @@ -69455,1049 +69766,350 @@ "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": { - "201": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Authentication Token", - "description": "Authentication Token", "type": "object", + "required": [ + "total_count", + "runners" + ], "properties": { - "token": { - "description": "The token used for authentication", - "type": "string", - "examples": [ - "v1.1f699f1069f60xxx" - ] - }, - "expires_at": { - "description": "The time this token expires", - "type": "string", - "format": "date-time", - "examples": [ - "2016-07-11T22:14:10Z" - ] - }, - "permissions": { - "type": "object", - "examples": [ - { - "issues": "read", - "deployments": "write" - } - ] + "total_count": { + "type": "number" }, - "repositories": { - "description": "The repositories this token has access to", + "runners": { "type": "array", "items": { - "title": "Repository", - "description": "A repository on GitHub.", + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", "type": "object", "properties": { "id": { - "description": "Unique identifier of the repository", + "description": "The unique identifier of the hosted runner.", "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + 5 ] }, "name": { - "description": "The name of the repository.", + "description": "The name of the hosted runner.", "type": "string", "examples": [ - "Team Environment" + "my-github-hosted-runner" ] }, - "full_name": { - "type": "string", + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", "examples": [ - "octocat/Hello-World" + 2 ] }, - "license": { + "image_details": { "anyOf": [ { "type": "null" }, { - "title": "License Simple", - "description": "License Simple", + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", "type": "object", "properties": { - "key": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", "type": "string", "examples": [ - "mit" + "ubuntu-20.04" ] }, - "name": { - "type": "string", + "size_gb": { + "description": "Image size in GB.", + "type": "integer", "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" + 86 ] }, - "node_id": { + "display_name": { + "description": "Display name for this image.", "type": "string", "examples": [ - "MDc6TGljZW5zZW1pdA==" + 20.04 ] }, - "html_url": { + "source": { + "description": "The image provider.", "type": "string", - "format": "uri" + "enum": [ + "github", + "partner", + "custom" + ] } }, "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" + "id", + "size_gb", + "display_name", + "source" ] } ] }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", + "machine_size_details": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { + "description": "The ID used for the `size` parameter when creating a new runner.", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "8-core" ] }, - "type": { - "type": "string", + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", "examples": [ - "User" + 8 ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", "examples": [ - "\"2020-07-09T00:17:55Z\"" + 32 ] }, - "user_view_type": { - "type": "string", + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", "examples": [ - "public" + 300 ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" + "cpu_cores", + "memory_gb", + "storage_gb" ] }, - "svn_url": { + "status": { + "description": "The status of the runner.", "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", "examples": [ - 108 + "Ready" ] }, - "default_branch": { - "description": "The default branch of the repository.", + "platform": { + "description": "The operating system of the image.", "type": "string", "examples": [ - "master" + "linux-x64" ] }, - "open_issues_count": { + "maximum_runners": { + "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", "type": "integer", + "default": 10, "examples": [ - 0 + 5 ] }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", "type": "boolean", "examples": [ true ] }, - "topics": { + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", "type": "array", "items": { - "type": "string" + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", + "type": "object", + "properties": { + "enabled": { + "description": "Whether public IP is enabled.", + "type": "boolean", + "examples": [ + true + ] + }, + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "examples": [ + "20.80.208.150" + ] + }, + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "examples": [ + 28 + ] + } + } } }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", "type": [ "string", "null" ], "format": "date-time", "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" + "2022-10-09T23:39:01Z" ] - }, - "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" + "image_details", + "machine_size_details", + "status", + "public_ip_enabled", + "platform" ] } - }, - "single_file": { - "type": [ - "string", - "null" - ], - "examples": [ - "config.yaml" - ] - }, - "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": 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": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "self-hosted-runner-groups" } } }, - "/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/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" ], - "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/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization" }, "parameters": [ { @@ -70508,56 +70120,62 @@ "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": { - "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", - "examples": [ - "v1.1f699f1069f60xxx" - ] - }, - "expires_at": { - "description": "The time this token expires", - "type": "string", - "format": "date-time", - "examples": [ - "2016-07-11T22:14:10Z" - ] - }, - "permissions": { - "type": "object", - "examples": [ - { - "issues": "read", - "deployments": "write" - } - ] + "total_count": { + "type": "number" }, "repositories": { - "description": "The repositories this token has access to", "type": "array", "items": { - "title": "Repository", - "description": "A repository on GitHub.", + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { "id": { - "description": "Unique identifier of the repository", "type": "integer", "format": "int64", "examples": [ - 42 + 1296269 ] }, "node_id": { @@ -70567,10 +70185,9 @@ ] }, "name": { - "description": "The name of the repository.", "type": "string", "examples": [ - "Team Environment" + "Hello-World" ] }, "full_name": { @@ -70579,96 +70196,6 @@ "octocat/Hello-World" ] }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, "owner": { "title": "Simple User", "description": "A GitHub user.", @@ -70838,8 +70365,6 @@ ] }, "private": { - "description": "Whether the repository is private or public.", - "default": false, "type": "boolean" }, "html_url": { @@ -70976,10 +70501,7 @@ ] }, "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] + "type": "string" }, "issue_comment_url": { "type": "string", @@ -71050,10 +70572,7 @@ ] }, "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] + "type": "string" }, "stargazers_url": { "type": "string", @@ -71103,19 +70622,12 @@ ] }, "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] + "type": "string" }, "mirror_url": { "type": [ "string", "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { @@ -71126,20 +70638,12 @@ ] }, "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] + "type": "string" }, "homepage": { "type": [ "string", "null" - ], - "format": "uri", - "examples": [ - "https://github.com" ] }, "language": { @@ -71149,50 +70653,26 @@ ] }, "forks_count": { - "type": "integer", - "examples": [ - 9 - ] + "type": "integer" }, "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] + "type": "integer" }, "watchers_count": { - "type": "integer", - "examples": [ - 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", - "examples": [ - 108 - ] + "type": "integer" }, "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] + "type": "string" }, "open_issues_count": { - "type": "integer", - "examples": [ - 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", - "examples": [ - true - ] + "type": "boolean" }, "topics": { "type": "array", @@ -71201,61 +70681,30 @@ } }, "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] + "type": "boolean" }, "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] + "type": "boolean" }, "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] + "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] + "type": "boolean" }, "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - 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": { @@ -71288,136 +70737,238 @@ "2011-01-26T19:14:43Z" ] }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", "examples": [ - true + "admin" ] }, "temp_clone_token": { "type": "string" }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] + "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", - "examples": [ - 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", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# 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", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" + "license": { + "type": [ + "object", + "null" ], - "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." + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } }, - "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", + "examples": [ + 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", + "examples": [ + 0 + ] }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", + "watchers": { + "type": "integer", "examples": [ - true + 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", + "type": "boolean", "examples": [ - "\"2020-07-09T00:17:42Z\"" + false ] }, - "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", + "security_and_analysis": { + "type": [ + "object", + "null" + ], "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": [ @@ -71466,65 +71017,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", - "null" - ], - "examples": [ - "config.yaml" - ] - }, - "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" + "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 + }, + "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 + } + ] } } } @@ -71533,24 +71278,100 @@ } }, "x-github": { + "enabledForGitHubApps": true, "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + }, + "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" + ], + "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" + }, + "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": { + "selected_repository_ids": { + "description": "List of repository IDs that can access the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." + } + } + }, + "required": [ + "selected_repository_ids" + ] + }, + "examples": { + "default": { + "value": { + "selected_repository_ids": [ + 32, + 91 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "self-hosted-runner-groups" } } }, - "/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.", + "/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" ], - "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" + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization" }, "parameters": [ { @@ -71563,8 +71384,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": { @@ -71573,150 +71403,27 @@ } ], "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", - "examples": [ - 5 - ] - }, - "runner_group_id": { - "description": "The ID of the runner group.", - "type": "integer", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the runner.", - "type": "string", - "examples": [ - "iMac" - ] - }, - "os": { - "description": "The Operating System of the runner.", - "type": "string", - "examples": [ - "macos" - ] - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "examples": [ - "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" - }, - { - "id": 21, - "name": "no-gpu", - "type": "custom" - } - ] - } - } - } - } - } + "204": { + "description": "Response" } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "self-hosted-runner-groups" } }, "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.", + "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/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" + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization" }, "parameters": [ { @@ -71729,8 +71436,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": { @@ -71741,57 +71457,27 @@ "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" - } - } - } - } - } - } } }, "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": { + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": { "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.", + "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" ], - "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#list-self-hosted-runners-in-a-group-for-an-organization" }, "parameters": [ { @@ -71804,192 +71490,33 @@ } }, { - "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" } - } - ], - "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" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "self-hosted-runners" - } - }, - "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": [ - "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" - }, - "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": "runner_id", - "description": "Unique identifier of the self-hosted runner.", - "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 } } ], - "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": { "200": { "description": "Response", @@ -71999,38 +71526,97 @@ "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." + "examples": [ + 5 + ] + }, + "runner_group_id": { + "description": "The ID of the runner group.", + "type": "integer", + "examples": [ + 1 + ] }, "name": { + "description": "The name of the runner.", "type": "string", - "description": "Name of the label." + "examples": [ + "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" + "examples": [ + "macos" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "examples": [ + "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" ] } } @@ -72039,109 +71625,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": [ { @@ -72154,8 +71727,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": { @@ -72169,27 +71742,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 ] } } @@ -72198,157 +71770,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": [ { @@ -72360,6 +71804,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.", @@ -72371,124 +71824,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": [ { @@ -72501,8 +71857,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": { @@ -72510,171 +71866,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.", @@ -72712,56 +71946,97 @@ "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": { - "name": { - "description": "The name of the secret.", - "type": "string", + "id": { + "description": "The ID of the runner.", + "type": "integer", "examples": [ - "SECRET_TOKEN" + 5 ] }, - "created_at": { - "type": "string", - "format": "date-time" + "runner_group_id": { + "description": "The ID of the runner group.", + "type": "integer", + "examples": [ + 1 + ] }, - "updated_at": { + "name": { + "description": "The name of the runner.", "type": "string", - "format": "date-time" + "examples": [ + "iMac" + ] }, - "visibility": { - "description": "Visibility of a secret", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" + "os": { + "description": "The Operating System of the runner.", + "type": "string", + "examples": [ + "macos" + ] }, - "selected_repositories_url": { + "status": { + "description": "The status of the runner.", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/organizations/org/secrets/my_secret/repositories" + "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", - "created_at", - "updated_at", - "visibility" + "os", + "status", + "busy", + "labels" ] } } @@ -72770,26 +72045,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" + } + ] } ] } @@ -72811,21 +72122,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": [ { @@ -72844,60 +72155,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", - "examples": [ - "1234567" - ] - }, - "key": { - "description": "The Base64 encoded public key.", - "type": "string", - "examples": [ - "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" - ] - }, - "id": { - "type": "integer", - "examples": [ - 2 - ] - }, - "url": { - "type": "string", - "examples": [ - "https://api.github.com/user/keys/2" - ] - }, - "title": { - "type": "string", - "examples": [ - "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", - "examples": [ - "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" + } + ] } } } @@ -72908,123 +72233,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.", - "type": "string", - "examples": [ - "SECRET_TOKEN" - ] - }, - "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", - "examples": [ - "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": [ { @@ -73035,15 +72258,6 @@ "schema": { "type": "string" } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } } ], "requestBody": { @@ -73052,49 +72266,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" } } } @@ -73103,90 +72316,248 @@ }, "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", + "examples": [ + 5 + ] + }, + "runner_group_id": { + "description": "The ID of the runner group.", + "type": "integer", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the runner.", + "type": "string", + "examples": [ + "iMac" + ] + }, + "os": { + "description": "The Operating System of the runner.", + "type": "string", + "examples": [ + "macos" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "examples": [ + "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": [ { @@ -73197,62 +72568,56 @@ "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", + "examples": [ + "v1.1f699f1069f60xxx" + ] + }, + "expires_at": { + "description": "The time this token expires", + "type": "string", + "format": "date-time", + "examples": [ + "2016-07-11T22:14:10Z" + ] + }, + "permissions": { + "type": "object", + "examples": [ + { + "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", "type": "integer", "format": "int64", "examples": [ - 1296269 + 42 ] }, "node_id": { @@ -73262,9 +72627,10 @@ ] }, "name": { + "description": "The name of the repository.", "type": "string", "examples": [ - "Hello-World" + "Team Environment" ] }, "full_name": { @@ -73273,6 +72639,96 @@ "octocat/Hello-World" ] }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, "owner": { "title": "Simple User", "description": "A GitHub user.", @@ -73442,6 +72898,8 @@ ] }, "private": { + "description": "Whether the repository is private or public.", + "default": false, "type": "boolean" }, "html_url": { @@ -73578,7 +73036,10 @@ ] }, "git_url": { - "type": "string" + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] }, "issue_comment_url": { "type": "string", @@ -73649,7 +73110,10 @@ ] }, "ssh_url": { - "type": "string" + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] }, "stargazers_url": { "type": "string", @@ -73699,12 +73163,19 @@ ] }, "clone_url": { - "type": "string" + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] }, "mirror_url": { "type": [ "string", "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { @@ -73715,12 +73186,20 @@ ] }, "svn_url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] }, "homepage": { "type": [ "string", "null" + ], + "format": "uri", + "examples": [ + "https://github.com" ] }, "language": { @@ -73730,26 +73209,50 @@ ] }, "forks_count": { - "type": "integer" + "type": "integer", + "examples": [ + 9 + ] }, "stargazers_count": { - "type": "integer" + "type": "integer", + "examples": [ + 80 + ] }, "watchers_count": { - "type": "integer" + "type": "integer", + "examples": [ + 80 + ] }, "size": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" + "type": "integer", + "examples": [ + 108 + ] }, "default_branch": { - "type": "string" + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] }, "open_issues_count": { - "type": "integer" + "type": "integer", + "examples": [ + 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", + "examples": [ + true + ] }, "topics": { "type": "array", @@ -73758,30 +73261,61 @@ } }, "has_issues": { - "type": "boolean" + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_projects": { - "type": "boolean" + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_wiki": { - "type": "boolean" + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_pages": { "type": "boolean" }, "has_downloads": { - "type": "boolean" + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] }, "has_discussions": { - "type": "boolean" + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] }, "archived": { + "description": "Whether the repository is archived.", + "default": false, "type": "boolean" }, "disabled": { - "type": "boolean" + "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": { @@ -73814,238 +73348,136 @@ "2011-01-26T19:14:43Z" ] }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", "examples": [ - "admin" + true ] }, "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", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# 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", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true ] }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - } + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] }, - "forks": { - "type": "integer", + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", "examples": [ - 0 + false ] }, - "open_issues": { - "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", "examples": [ - 0 + false ] }, - "watchers": { - "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 + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", "examples": [ - 0 + true ] }, "allow_forking": { + "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { - "type": "boolean", + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", "examples": [ - false + "\"2020-07-09T00:17:42Z\"" ] }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], + "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": { - "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": [ @@ -74094,829 +73526,91 @@ "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.", - "type": "string", - "examples": [ - "USERNAME" - ] - }, - "value": { - "description": "The value of the variable.", - "type": "string", - "examples": [ - "octocat" - ] - }, - "created_at": { - "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time", - "examples": [ - "2019-01-24T22:45:36.000Z" - ] - }, - "updated_at": { - "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time", - "examples": [ - "2019-01-24T22:45:36.000Z" - ] - }, - "visibility": { - "description": "Visibility of a variable", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" - }, - "selected_repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "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.", - "type": "string", - "examples": [ - "USERNAME" - ] - }, - "value": { - "description": "The value of the variable.", - "type": "string", - "examples": [ - "octocat" - ] }, - "created_at": { - "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time", + "single_file": { + "type": [ + "string", + "null" + ], "examples": [ - "2019-01-24T22:45:36.000Z" + "config.yaml" ] }, - "updated_at": { - "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", "type": "string", - "format": "date-time", - "examples": [ - "2019-01-24T22:45:36.000Z" - ] - }, - "visibility": { - "description": "Visibility of a variable", "enum": [ "all", - "private", "selected" - ], - "type": "string" - }, - "selected_repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "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": [ { @@ -74927,62 +73621,56 @@ "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", + "examples": [ + "v1.1f699f1069f60xxx" + ] + }, + "expires_at": { + "description": "The time this token expires", + "type": "string", + "format": "date-time", + "examples": [ + "2016-07-11T22:14:10Z" + ] + }, + "permissions": { + "type": "object", + "examples": [ + { + "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", "type": "integer", "format": "int64", "examples": [ - 1296269 + 42 ] }, "node_id": { @@ -74992,9 +73680,10 @@ ] }, "name": { + "description": "The name of the repository.", "type": "string", "examples": [ - "Hello-World" + "Team Environment" ] }, "full_name": { @@ -75003,6 +73692,96 @@ "octocat/Hello-World" ] }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, "owner": { "title": "Simple User", "description": "A GitHub user.", @@ -75172,6 +73951,8 @@ ] }, "private": { + "description": "Whether the repository is private or public.", + "default": false, "type": "boolean" }, "html_url": { @@ -75308,7 +74089,10 @@ ] }, "git_url": { - "type": "string" + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] }, "issue_comment_url": { "type": "string", @@ -75379,7 +74163,10 @@ ] }, "ssh_url": { - "type": "string" + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] }, "stargazers_url": { "type": "string", @@ -75429,12 +74216,19 @@ ] }, "clone_url": { - "type": "string" + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] }, "mirror_url": { "type": [ "string", "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { @@ -75445,12 +74239,20 @@ ] }, "svn_url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] }, "homepage": { "type": [ "string", "null" + ], + "format": "uri", + "examples": [ + "https://github.com" ] }, "language": { @@ -75460,26 +74262,50 @@ ] }, "forks_count": { - "type": "integer" + "type": "integer", + "examples": [ + 9 + ] }, "stargazers_count": { - "type": "integer" + "type": "integer", + "examples": [ + 80 + ] }, "watchers_count": { - "type": "integer" + "type": "integer", + "examples": [ + 80 + ] }, "size": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" + "type": "integer", + "examples": [ + 108 + ] }, "default_branch": { - "type": "string" + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] }, "open_issues_count": { - "type": "integer" + "type": "integer", + "examples": [ + 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", + "examples": [ + true + ] }, "topics": { "type": "array", @@ -75488,30 +74314,61 @@ } }, "has_issues": { - "type": "boolean" + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_projects": { - "type": "boolean" + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_wiki": { - "type": "boolean" + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_pages": { "type": "boolean" }, "has_downloads": { - "type": "boolean" + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] }, "has_discussions": { - "type": "boolean" + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] }, "archived": { + "description": "Whether the repository is archived.", + "default": false, "type": "boolean" }, "disabled": { - "type": "boolean" + "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": { @@ -75544,238 +74401,136 @@ "2011-01-26T19:14:43Z" ] }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", "examples": [ - "admin" + true ] }, "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", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# 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", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true ] }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - } + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] }, - "forks": { - "type": "integer", + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", "examples": [ - 0 + false ] }, - "open_issues": { - "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", "examples": [ - 0 + false ] }, - "watchers": { - "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 + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", "examples": [ - 0 + true ] }, "allow_forking": { + "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { - "type": "boolean", + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", "examples": [ - false + "\"2020-07-09T00:17:42Z\"" ] }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], + "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": { - "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": [ @@ -75824,114 +74579,91 @@ "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", + "null" + ], + "examples": [ + "config.yaml" + ] + }, + "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": [ { @@ -75944,73 +74676,160 @@ } }, { - "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", + "examples": [ + 5 + ] + }, + "runner_group_id": { + "description": "The ID of the runner group.", + "type": "integer", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the runner.", + "type": "string", + "examples": [ + "iMac" + ] + }, + "os": { + "description": "The Operating System of the runner.", + "type": "string", + "examples": [ + "macos" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "examples": [ + "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": [ { @@ -76023,16 +74842,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": { @@ -76044,27 +74855,56 @@ "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": [ + "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": "self-hosted-runners" + } + } + }, + "/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": [ { @@ -76077,16 +74917,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": { @@ -76095,68 +74927,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" } } ], @@ -76166,42 +75075,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" - } } } } @@ -76214,200 +75110,69 @@ "application/json": { "schema": { "type": "object", + "required": [ + "total_count", + "labels" + ], "properties": { - "attestations_subject_digests": { - "type": "object", - "additionalProperties": { - "type": [ - "array", - "null" - ], - "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" } ] } @@ -76415,27 +75180,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": [ { @@ -76446,6 +75265,15 @@ "schema": { "type": "string" } + }, + { + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "requestBody": { @@ -76454,58 +75282,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" ] } } @@ -76515,7 +75312,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", @@ -76542,27 +75413,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": [ { @@ -76575,22 +75474,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", @@ -76622,22 +75586,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": [ { @@ -76650,24 +75614,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": { @@ -76692,14 +75736,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" @@ -76707,11 +75755,11 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "errors": { + "type": "array", + "items": { + "type": "string" + } } } } @@ -76722,51 +75770,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.", @@ -76777,22 +75798,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 } } ], @@ -76803,38 +75823,59 @@ "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.", + "type": "string", + "examples": [ + "SECRET_TOKEN" + ] }, - "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", + "examples": [ + "https://api.github.com/organizations/org/secrets/my_secret/repositories" + ] } - } + }, + "required": [ + "name", + "created_at", + "updated_at", + "visibility" + ] } } } @@ -76842,156 +75883,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": [ { @@ -77002,24 +75949,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": { @@ -77028,200 +75957,60 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + "title": "ActionsPublicKey", + "description": "The public key used for setting Actions Secrets.", + "type": "object", + "properties": { + "key_id": { + "description": "The identifier for the key.", + "type": "string", + "examples": [ + "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", + "examples": [ + "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" + ] + }, + "id": { + "type": "integer", + "examples": [ + 2 + ] + }, + "url": { + "type": "string", + "examples": [ + "https://api.github.com/user/keys/2" + ] + }, + "title": { + "type": "string", + "examples": [ + "ssh-rsa AAAAB3NzaC1yc2EAAA" + ] + }, + "created_at": { + "type": "string", + "examples": [ + "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" + } } } } @@ -77231,22 +76020,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": [ { @@ -77259,8 +76048,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": { @@ -77269,29 +76058,62 @@ } ], "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": { - "type": "string" + "name": { + "description": "The name of the secret.", + "type": "string", + "examples": [ + "SECRET_TOKEN" + ] }, - "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", + "examples": [ + "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" } } } @@ -77302,20 +76124,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": [ { @@ -77328,8 +76150,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": { @@ -77337,103 +76159,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", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "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": [ { @@ -77446,8 +76267,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": { @@ -77463,22 +76284,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": [ { @@ -77490,6 +76311,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).\"", @@ -77507,51 +76337,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": { @@ -77560,2040 +76345,949 @@ "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": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "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", - "null" - ] - }, - "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", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] - } - ] - } - }, - "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", - "null" - ], - "format": "date-time" - }, - "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", - "null" - ], - "format": "uri" - }, - "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 - } - ], - "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", - "null" - ], - "format": "uri" - }, - "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", + "required": [ + "total_count", + "repositories" + ], "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" + "total_count": { + "type": "integer" }, - "managers": { - "description": "The campaign managers", + "repositories": { "type": "array", "items": { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 ] }, - "login": { + "node_id": { "type": "string", "examples": [ - "octocat" + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "id": { - "type": "integer", - "format": "int64", + "name": { + "type": "string", "examples": [ - 1 + "Hello-World" ] }, - "node_id": { + "full_name": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "octocat/Hello-World" ] }, - "avatar_url": { + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "https://github.com/octocat/Hello-World" ] }, - "gravatar_id": { + "description": { "type": [ "string", "null" ], "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "This your first repo!" ] }, + "fork": { + "type": "boolean" + }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "https://api.github.com/repos/octocat/Hello-World" ] }, - "html_url": { + "archive_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/octocat" + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, - "followers_url": { + "assignees_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, - "following_url": { + "blobs_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, - "gists_url": { + "branches_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, - "starred_url": { + "collaborators_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, - "subscriptions_url": { + "comments_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, - "organizations_url": { + "commits_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, - "repos_url": { + "compare_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, - "events_url": { + "contents_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, - "received_events_url": { + "contributors_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, - "type": { + "deployments_url": { "type": "string", + "format": "uri", "examples": [ - "User" + "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { + "downloads_url": { "type": "string", + "format": "uri", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, - "user_view_type": { + "events_url": { "type": "string", + "format": "uri", "examples": [ - "public" + "http://api.github.com/repos/octocat/Hello-World/events" ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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", - "null" + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" ] }, - "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" + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, - "url": { + "git_refs_url": { "type": "string", - "format": "uri" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] }, - "html_url": { + "git_tags_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/orgs/rails/teams/core" + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, - "members_url": { + "git_url": { "type": "string" }, - "repositories_url": { + "issue_comment_url": { "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] - } - ] - } - }, - "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", - "null" - ], - "format": "date-time" - }, - "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", - "null" - ], - "format": "uri" - }, - "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": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, - "login": { + "issue_events_url": { "type": "string", "examples": [ - "octocat" + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, - "id": { - "type": "integer", - "format": "int64", + "issues_url": { + "type": "string", "examples": [ - 1 + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, - "node_id": { + "keys_url": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, - "avatar_url": { + "labels_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, - "gravatar_id": { - "type": [ - "string", - "null" - ], + "languages_url": { + "type": "string", + "format": "uri", "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "http://api.github.com/repos/octocat/Hello-World/languages" ] }, - "url": { + "merges_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "http://api.github.com/repos/octocat/Hello-World/merges" ] }, - "html_url": { + "milestones_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/octocat" + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, - "followers_url": { + "notifications_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, - "following_url": { + "pulls_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, - "gists_url": { + "releases_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, - "starred_url": { + "ssh_url": { + "type": "string" + }, + "stargazers_url": { "type": "string", + "format": "uri", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, - "subscriptions_url": { + "statuses_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, - "organizations_url": { + "subscribers_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, - "repos_url": { + "subscription_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, - "events_url": { + "tags_url": { "type": "string", + "format": "uri", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "http://api.github.com/repos/octocat/Hello-World/tags" ] }, - "received_events_url": { + "teams_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "http://api.github.com/repos/octocat/Hello-World/teams" ] }, - "type": { + "trees_url": { "type": "string", "examples": [ - "User" + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, - "site_admin": { - "type": "boolean" + "clone_url": { + "type": "string" }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" + "mirror_url": { + "type": [ + "string", + "null" ] }, - "user_view_type": { + "hooks_url": { "type": "string", + "format": "uri", "examples": [ - "public" + "http://api.github.com/repos/octocat/Hello-World/hooks" ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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": { + "svn_url": { "type": "string" }, - "slug": { - "type": "string" + "homepage": { + "type": [ + "string", + "null" + ] }, - "description": { + "language": { "type": [ "string", "null" ] }, - "privacy": { - "type": "string" + "forks_count": { + "type": "integer" }, - "notification_setting": { + "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" }, - "permission": { + "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", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, "permissions": { "type": "object", "properties": { - "pull": { + "admin": { "type": "boolean" }, - "triage": { + "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, - "maintain": { + "triage": { "type": "boolean" }, - "admin": { + "pull": { "type": "boolean" } + } + }, + "role_name": { + "type": "string", + "examples": [ + "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", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# 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", + "null" + ], + "format": "uri" + } }, "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" + "url", + "html_url", + "key", + "name" ] }, - "url": { - "type": "string", - "format": "uri" + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } }, - "html_url": { - "type": "string", - "format": "uri", + "forks": { + "type": "integer", "examples": [ - "https://github.com/orgs/rails/teams/core" + 0 ] }, - "members_url": { - "type": "string" + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] }, - "repositories_url": { - "type": "string", - "format": "uri" + "watchers": { + "type": "integer", + "examples": [ + 0 + ] }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "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": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", + "status": { "type": "string", - "examples": [ - "admin" + "enum": [ + "enabled", + "disabled" ] - }, - "privacy": { - "description": "The level of privacy this team should have", + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { "type": "string", - "examples": [ - "closed" + "enum": [ + "enabled", + "disabled" ] - }, - "notification_setting": { - "description": "The notification setting the team has set", + } + } + }, + "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", - "examples": [ - "notifications_enabled" + "enum": [ + "enabled", + "disabled" ] - }, - "html_url": { + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" + "enum": [ + "enabled", + "disabled" ] - }, - "repositories_url": { + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" + "enum": [ + "enabled", + "disabled" ] - }, - "slug": { + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { "type": "string", - "examples": [ - "justice-league" + "enum": [ + "enabled", + "disabled" ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" + "enum": [ + "enabled", + "disabled" ] } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] + } } - ] + } + }, + "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", - "null" - ], - "format": "date-time" - }, - "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", - "null" - ], - "format": "uri" - }, - "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" + ] } } } @@ -79604,20 +77298,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": [ { @@ -79630,12 +77324,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" } } ], @@ -79645,698 +77339,416 @@ "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", - "null" - ], - "format": "uri" - }, - "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 + ] } } } } } }, + "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": { - "title": "Campaign summary", - "description": "The campaign metadata and alert stats.", "type": "object", + "required": [ + "total_count", + "variables" + ], "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" + "total_count": { + "type": "integer" }, - "managers": { - "description": "The campaign managers", + "variables": { "type": "array", "items": { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Actions Variable for an Organization", + "description": "Organization variable for GitHub Actions.", "type": "object", "properties": { "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { + "description": "The name of the variable.", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "USERNAME" ] }, - "type": { + "value": { + "description": "The value of the variable.", "type": "string", "examples": [ - "User" + "octocat" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { + "created_at": { + "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", "type": "string", + "format": "date-time", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "2019-01-24T22:45:36.000Z" ] }, - "user_view_type": { + "updated_at": { + "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", "type": "string", + "format": "date-time", "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "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", - "null" + "2019-01-24T22:45:36.000Z" ] }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { + "visibility": { + "description": "Visibility of a variable", + "enum": [ + "all", + "private", + "selected" + ], "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": { + "selected_repositories_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] - } + "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", - "null" - ], - "format": "date-time" - }, - "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", - "null" - ], - "format": "uri" - }, - "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 } } } @@ -80346,20 +77758,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": [ { @@ -80372,60 +77786,89 @@ } }, { - "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": { - "type": "string" + "name": { + "description": "The name of the variable.", + "type": "string", + "examples": [ + "USERNAME" + ] }, - "documentation_url": { - "type": "string" + "value": { + "description": "The value of the variable.", + "type": "string", + "examples": [ + "octocat" + ] }, - "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.", + "type": "string", + "format": "date-time", + "examples": [ + "2019-01-24T22:45:36.000Z" + ] }, - "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.", + "type": "string", + "format": "date-time", + "examples": [ + "2019-01-24T22:45:36.000Z" + ] }, - "message": { + "visibility": { + "description": "Visibility of a variable", + "enum": [ + "all", + "private", + "selected" + ], "type": "string" }, - "documentation_url": { - "type": "string" + "selected_repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "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" } } } @@ -80436,22 +77879,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": [ { @@ -80464,42 +77905,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": { - "type": [ - "string", - "null" - ], - "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" } @@ -80521,69 +78067,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": { @@ -80592,488 +78075,43 @@ "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", - "null" - ], - "description": "State of a code scanning alert.", - "enum": [ - "open", - "dismissed", - "fixed", - null - ] - }, - "fixed_at": { - "type": [ - "string", - "null" - ], - "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 - }, - "dismissed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "dismissed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissed_reason": { - "type": [ - "string", - "null" - ], - "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", - "enum": [ - "false positive", - "won't fix", - "used in tests", - null - ] - }, - "dismissed_comment": { - "type": [ - "string", - "null" - ], - "description": "The dismissal comment associated with the dismissal of the alert.", - "maxLength": 280 - }, - "rule": { - "type": "object", - "properties": { - "id": { - "type": [ - "string", - "null" - ], - "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": { - "type": [ - "string", - "null" - ], - "description": "The severity of the alert.", - "enum": [ - "none", - "note", - "warning", - "error", - null - ] - }, - "security_severity_level": { - "type": [ - "string", - "null" - ], - "description": "The security severity of the alert.", - "enum": [ - "low", - "medium", - "high", - "critical", - null - ] - }, - "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": { - "type": [ - "array", - "null" - ], - "description": "A set of tags applicable for the rule.", - "items": { - "type": "string" - } - }, - "help": { - "type": [ - "string", - "null" - ], - "description": "Detailed documentation for the rule as GitHub Flavored Markdown." - }, - "help_uri": { - "type": [ - "string", - "null" - ], - "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": { - "type": [ - "string", - "null" - ], - "description": "The version of the tool used to generate the code scanning analysis." - }, - "guid": { - "type": [ - "string", - "null" - ], - "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", - "null" - ], - "description": "State of a code scanning alert.", - "enum": [ - "open", - "dismissed", - "fixed", - null - ] - }, - "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", - "null" - ], - "description": "A classification of the file. For example to identify it as generated.", - "enum": [ - "source", - "generated", - "test", - "library", - null - ] - } - } - } - }, - "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", - "description": "A unique identifier of the repository.", "examples": [ 1296269 ] }, "node_id": { "type": "string", - "description": "The GraphQL identifier of the repository.", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", - "description": "The name of the repository.", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", - "description": "The full, globally unique, name of the repository.", "examples": [ "octocat/Hello-World" ] @@ -81247,13 +78285,11 @@ ] }, "private": { - "type": "boolean", - "description": "Whether the repository is private." + "type": "boolean" }, "html_url": { "type": "string", "format": "uri", - "description": "The URL to view the repository on GitHub.com.", "examples": [ "https://github.com/octocat/Hello-World" ] @@ -81263,287 +78299,596 @@ "string", "null" ], - "description": "The repository description.", "examples": [ "This your first repo!" ] }, "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." + "type": "boolean" }, "url": { "type": "string", "format": "uri", - "description": "The URL to get more information about the repository from the GitHub API.", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", - "description": "A template for the API URL to download the repository as an archive.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", - "description": "A template for the API URL to list the available assignees for issues in the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", - "description": "A template for the API URL to get information about branches in the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", - "description": "A template for the API URL to get information about collaborators of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", - "description": "A template for the API URL to get information about comments on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/comments{/number}" + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", - "description": "A template for the API URL to get information about commits on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", - "description": "A template for the API URL to compare two commits or refs.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", - "description": "A template for the API URL to get the contents of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", - "description": "A template for the API URL to list the contributors to the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contributors" + "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", - "description": "The API URL to list the deployments of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/deployments" + "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", - "description": "The API URL to list the downloads on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/downloads" + "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", - "description": "The API URL to list the events of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/events" + "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", - "description": "The API URL to list the forks of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/forks" + "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", - "description": "A template for the API URL to get information about Git commits of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", - "description": "A template for the API URL to get information about Git refs of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", - "description": "A template for the API URL to get information about Git tags of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, + "git_url": { + "type": "string" + }, "issue_comment_url": { "type": "string", - "description": "A template for the API URL to get information about issue comments on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", - "description": "A template for the API URL to get information about issue events on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", - "description": "A template for the API URL to get information about issues on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues{/number}" + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", - "description": "A template for the API URL to get information about deploy keys on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", - "description": "A template for the API URL to get information about labels of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/labels{/name}" + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", - "description": "The API URL to get information about the languages of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/languages" + "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", - "description": "The API URL to merge branches in the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/merges" + "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", - "description": "A template for the API URL to get information about milestones of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", - "description": "A template for the API URL to get information about notifications on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", - "description": "A template for the API URL to get information about pull requests on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", - "description": "A template for the API URL to get information about releases on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/releases{/id}" + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, + "ssh_url": { + "type": "string" + }, "stargazers_url": { "type": "string", "format": "uri", - "description": "The API URL to list the stargazers on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/stargazers" + "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", - "description": "A template for the API URL to get information about statuses of a commit.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", - "description": "The API URL to list the subscribers on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscribers" + "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", - "description": "The API URL to subscribe to notifications for this repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscription" + "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", - "description": "The API URL to get information about tags on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/tags" + "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", - "description": "The API URL to list the teams on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/teams" + "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" ] }, "hooks_url": { "type": "string", "format": "uri", - "description": "The API URL to list the hooks on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks" + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "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", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# 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", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "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": [ @@ -81594,383 +78939,16 @@ "trees_url", "url" ] - }, - "dismissal_approved_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] } - }, - "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 - }, - "classifications": [] - }, - "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances", - "repository": { + "value": { + "total_count": 1, + "repositories": [ + { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", @@ -82017,6 +78995,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}", @@ -82028,6 +79007,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", @@ -82035,90 +79015,115 @@ "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" } - } - ] + ] + } } } } - }, - "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" - } - } - } - } + "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" } }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "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": "code-scanning", - "subcategory": "code-scanning" + "category": "actions", + "subcategory": "variables" } } }, - "/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}/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": [ - "code-security" + "actions" ], - "operationId": "code-security/get-configurations-for-org", + "operationId": "actions/add-selected-repo-to-org-variable", "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/actions/variables#add-selected-repository-to-an-organization-variable" }, "parameters": [ { @@ -82131,24 +79136,110 @@ } }, { - "name": "target_type", - "in": "query", - "description": "The target type of the code security configuration", - "required": false, + "name": "name", + "description": "The name of the variable.", + "in": "path", + "required": true, "schema": { - "type": "string", - "enum": [ - "global", - "all" - ], - "default": "all" + "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", - "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 @@ -82171,364 +79262,522 @@ "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": "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", - "null" - ], - "description": "Feature options for code scanning", - "properties": { - "allow_advanced": { - "type": [ - "boolean", - "null" - ], - "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", + "properties": { + "attestations_subject_digests": { + "type": "object", + "additionalProperties": { "type": [ - "object", + "array", "null" ], - "description": "Feature options for code scanning default setup", - "properties": { - "runner_type": { - "type": [ - "string", - "null" - ], - "enum": [ - "standard", - "labeled", - "not_set", - null - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "type": [ - "string", - "null" - ], - "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": { + "items": { + "type": "object", + "properties": { + "bundle": { "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" + "mediaType": { + "type": "string" }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] + "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" } } } }, - "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" + "description": "Mapping of subject digest to bundles." + }, + "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." + }, + "previous": { + "type": "string", + "description": "The cursor to the previous page." + } }, - "updated_at": { - "type": "string", - "format": "date-time" - } + "description": "Information about the current page." } } }, "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": [ + "value": { + "attestations_subject_digests": [ + { + "sha256:abc": [ { - "security_configuration_id": 17, - "reviewer_id": 5678, - "reviewer_type": "TEAM" + "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}/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" }, - "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 + "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" }, - "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" + "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", + "content": { + "application/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/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" + } + }, + { + "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": { + "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/{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": [ + "orgs" + ], + "operationId": "orgs/delete-attestations-by-id", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/attestations#delete-attestations-by-id" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "attestation_id", + "description": "Attestation ID", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response" + }, + "204": { + "description": "Response" }, "403": { "description": "Forbidden", @@ -82586,22 +79835,51 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "code-security", - "subcategory": "configurations" + "category": "orgs", + "subcategory": "attestations" } - }, - "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.", + } + }, + "/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": [ - "code-security" + "orgs" ], - "operationId": "code-security/create-configuration", + "operationId": "orgs/list-attestations", "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/orgs#list-attestations" }, "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.", @@ -82610,624 +79888,197 @@ "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" + } } ], - "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 + "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" + } + } } } - }, - "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", - "null" - ], - "description": "Security Configuration feature options for code scanning", - "properties": { - "allow_advanced": { - "type": [ - "boolean", - "null" - ], - "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", - "null" - ], - "description": "Feature options for code scanning default setup", - "properties": { - "runner_type": { - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "type": [ - "string", - "null" - ], - "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" + } + }, + "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==" + } }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } ] } - } - } - } - } - }, - "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", - "null" - ], - "description": "Feature options for code scanning", - "properties": { - "allow_advanced": { - "type": [ - "boolean", - "null" - ], - "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", - "null" - ], - "description": "Feature options for code scanning default setup", - "properties": { - "runner_type": { - "type": [ - "string", - "null" - ], - "enum": [ - "standard", - "labeled", - "not_set", - null - ], - "description": "Whether to use labeled runners or standard GitHub runners." + }, + "repository_id": 1 }, - "runner_label": { - "type": [ - "string", - "null" - ], - "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" - ] + { + "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 } - } - }, - "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" } } } @@ -83238,22 +80089,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "code-security", - "subcategory": "configurations" + "category": "orgs", + "subcategory": "orgs" } } }, - "/orgs/{org}/code-security/configurations/defaults": { + "/orgs/{org}/blocks": { "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 users blocked by an organization", + "description": "List the users blocked by an organization.", "tags": [ - "code-security" + "orgs" ], - "operationId": "code-security/get-default-configurations", + "operationId": "orgs/list-blocked-users", "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/orgs/blocking#list-users-blocked-by-an-organization" }, "parameters": [ { @@ -83264,6 +80115,24 @@ "schema": { "type": "string" } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } } ], "responses": { @@ -83273,460 +80142,224 @@ "application/json": { "schema": { "type": "array", - "description": "A list of default code security configurations", "items": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "default_for_new_repos": { - "enum": [ - "public", - "private_and_internal", - "all" + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" ], - "description": "The visibility of newly created repositories for which the code security configuration will be applied to by default" + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] }, - "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", - "null" - ], - "description": "Feature options for code scanning", - "properties": { - "allow_advanced": { - "type": [ - "boolean", - "null" - ], - "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", - "null" - ], - "description": "Feature options for code scanning default setup", - "properties": { - "runner_type": { - "type": [ - "string", - "null" - ], - "enum": [ - "standard", - "labeled", - "not_set", - null - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "type": [ - "string", - "null" - ], - "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" - } - } + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] } }, "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" - } - }, - { - "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" - } + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "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" - }, - "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" + "category": "orgs", + "subcategory": "blocking" } } }, - "/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}/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": [ - "code-security" + "orgs" ], - "operationId": "code-security/detach-configuration", + "operationId": "orgs/check-blocked-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/code-security/configurations#detach-configurations-from-repositories" + "url": "https://docs.github.com/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization" }, "parameters": [ { @@ -83737,168 +80370,23 @@ "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": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" } } - }, + ], "responses": { "204": { - "description": "A header with no content is returned." - }, - "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", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "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" - } - } - } - } - } + "description": "If the user is blocked" }, "404": { - "description": "Resource not found", - "content": { - "application/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", + "description": "If the user is not blocked", "content": { "application/json": { "schema": { @@ -83927,22 +80415,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "code-security", - "subcategory": "configurations" + "category": "orgs", + "subcategory": "blocking" } - } - }, - "/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.", + }, + "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/get-configuration", + "operationId": "orgs/block-user", "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/orgs/blocking#block-a-user-from-an-organization" }, "parameters": [ { @@ -83955,387 +80441,88 @@ } }, { - "name": "configuration_id", - "description": "The unique identifier of the code security configuration.", + "name": "username", + "description": "The handle for the GitHub user account.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], "responses": { - "200": { - "description": "Response", + "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", - "null" - ], - "description": "Feature options for code scanning", - "properties": { - "allow_advanced": { - "type": [ - "boolean", - "null" - ], - "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", - "null" - ], - "description": "Feature options for code scanning default setup", - "properties": { - "runner_type": { - "type": [ - "string", - "null" - ], - "enum": [ - "standard", - "labeled", - "not_set", - null - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "type": [ - "string", - "null" - ], - "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": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" + { + "type": [ + "integer", + "null" ] + }, + { + "type": [ + "array", + "null" + ], + "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" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "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" } } } @@ -84346,20 +80533,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "code-security", - "subcategory": "configurations" + "category": "orgs", + "subcategory": "blocking" } }, - "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.", + "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/update-configuration", + "operationId": "orgs/unblock-user", "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/orgs/blocking#unblock-a-user-from-an-organization" }, "parameters": [ { @@ -84372,270 +80559,872 @@ } }, { - "name": "configuration_id", - "description": "The unique identifier of the code security configuration.", + "name": "username", + "description": "The handle for the GitHub user account.", "in": "path", "required": true, "schema": { - "type": "integer" + "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" - ] - }, - "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", - "null" - ], - "description": "Feature options for code scanning default setup", - "properties": { - "runner_type": { - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "type": [ - "string", - "null" - ], - "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": { + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "blocking" + } + } + }, + "/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.", + "tags": [ + "campaigns" + ], + "operationId": "campaigns/list-org-campaigns", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/campaigns/campaigns#list-campaigns-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": 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": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Campaign summary", + "description": "The campaign metadata and alert stats.", "type": "object", - "description": "Feature options for secret scanning delegated bypass", "properties": { - "reviewers": { + "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", - "description": "The bypass reviewers for secret scanning delegated bypass", "items": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], "properties": { - "reviewer_id": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" + "format": "int64", + "examples": [ + 1 + ] }, - "reviewer_type": { + "node_id": { "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "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", + "null" + ] + }, + "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", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "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", + "null" + ], + "format": "date-time" + }, + "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", + "null" + ], + "format": "uri" + }, + "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 + } + ], + "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" } - }, - "secret_scanning_validity_checks": { + } + } + } + } + }, + "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", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "minLength": 1, + "maxLength": 50 }, - "secret_scanning_non_provider_patterns": { + "description": { + "description": "A description for the campaign", "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "minLength": 1, + "maxLength": 255 }, - "secret_scanning_generic_secrets": { - "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "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" + } }, - "secret_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "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" + } }, - "private_vulnerability_reporting": { + "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 private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "date-time" }, - "enforcement": { - "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ] + "contact_link": { + "description": "The contact link of the campaign. Must be a URI.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "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": { - "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 + ] + } + ] } } } @@ -84644,373 +81433,537 @@ }, "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." + "description": "The number of the newly created campaign" }, - "target_type": { + "created_at": { "type": "string", - "description": "The type of the code security configuration.", - "enum": [ - "global", - "organization", - "enterprise" - ] + "format": "date-time", + "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." }, - "description": { + "updated_at": { "type": "string", - "description": "A description of the code security configuration" + "format": "date-time", + "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." }, - "advanced_security": { + "name": { "type": "string", - "description": "The enablement status of GitHub Advanced Security", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] + "description": "The campaign name" }, - "dependency_graph": { + "description": { "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "description": "The campaign description" }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "managers": { + "description": "The campaign managers", + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } }, - "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." - } + "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", + "null" + ] + }, + "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", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] } }, - "dependabot_alerts": { + "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 Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "date-time" }, - "dependabot_security_updates": { + "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 Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "date-time" }, - "code_scanning_options": { + "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": [ - "object", + "string", "null" ], - "description": "Feature options for code scanning", - "properties": { - "allow_advanced": { - "type": [ - "boolean", - "null" - ], - "description": "Whether to allow repos which use advanced setup" - } - } + "format": "date-time" }, - "code_scanning_default_setup": { + "state": { + "title": "Campaign state", + "description": "Indicates whether a campaign is open or closed", "type": "string", - "description": "The enablement status of code scanning default setup", "enum": [ - "enabled", - "disabled", - "not_set" + "open", + "closed" ] }, - "code_scanning_default_setup_options": { + "contact_link": { + "description": "The contact link of the campaign.", "type": [ - "object", + "string", "null" ], - "description": "Feature options for code scanning default setup", - "properties": { - "runner_type": { - "type": [ - "string", - "null" - ], - "enum": [ - "standard", - "labeled", - "not_set", - null - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "type": [ - "string", - "null" - ], - "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" - ] + "format": "uri" }, - "secret_scanning_delegated_bypass_options": { + "alert_stats": { "type": "object", - "description": "Feature options for secret scanning delegated bypass", + "additionalProperties": false, "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" - ] - } - } - } + "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" } - } - }, - "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" + }, + "required": [ + "open_count", + "closed_count", + "in_progress_count" ] - }, - "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 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": { @@ -85034,53 +81987,11 @@ } } } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": [ - "string", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -85105,8 +82016,8 @@ } } }, - "404": { - "description": "Resource not found", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -85131,25 +82042,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" } } @@ -85161,126 +82070,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/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/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization" + "url": "https://docs.github.com/rest/campaigns/campaigns#get-a-campaign-for-an-organization" }, "parameters": [ { @@ -85293,8 +82098,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": { @@ -85302,372 +82107,1248 @@ } } ], - "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", - "null" - ], - "description": "Feature options for code scanning", - "properties": { - "allow_advanced": { - "type": [ - "boolean", - "null" - ], - "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": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } }, - "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", - "null" - ], - "description": "Feature options for code scanning default setup", - "properties": { - "runner_type": { - "type": [ - "string", - "null" - ], - "enum": [ - "standard", - "labeled", - "not_set", - null - ], - "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", + "null" + ] + }, + "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": { - "type": [ - "string", - "null" - ], - "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", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] } }, - "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", + "null" + ], + "format": "date-time" + }, + "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", + "null" + ], + "format": "uri" + }, + "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/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", + "null" + ], + "format": "uri" + }, + "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": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - "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": { + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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", + "null" + ] + }, + "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", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], "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" + "examples": [ + 1 + ] }, - "reviewer_type": { + "node_id": { "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" ] } - } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] } - } + ] } }, - "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", + "null" + ], + "format": "date-time" + }, + "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", + "null" + ], + "format": "uri" + }, + "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 } } } @@ -85675,8 +83356,8 @@ } } }, - "403": { - "description": "Forbidden", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -85726,27 +83407,72 @@ } } } + }, + "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": "code-security", - "subcategory": "configurations" + "category": "campaigns", + "subcategory": "campaigns" } - } - }, - "/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.", + }, + "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/get-repositories-for-configuration", + "operationId": "campaigns/delete-campaign", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration" + "url": "https://docs.github.com/rest/campaigns/campaigns#delete-a-campaign-for-an-organization" }, "parameters": [ { @@ -85759,22 +83485,118 @@ } }, { - "name": "configuration_id", - "description": "The unique identifier of the code security configuration.", + "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": { + "application/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" + } + } + }, + "/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-scanning" + ], + "operationId": "code-scanning/list-alerts-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-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).\"", + "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", - "default": 30 + "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.", + "in": "query", + "required": false, + "schema": { + "type": [ + "string", + "null" + ], + "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." } }, { @@ -85796,13 +83618,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/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", - "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" + ] } } ], @@ -85815,57 +83708,70 @@ "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", + "null" + ], + "description": "State of a code scanning alert.", "enum": [ - "attached", - "attaching", - "detached", - "removed", - "enforced", - "failed", - "updating", - "removed_by_enterprise" + "open", + "dismissed", + "fixed", + null ] }, - "repository": { - "title": "Simple Repository", - "description": "A GitHub repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "A unique identifier of the repository.", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "description": "The GraphQL identifier of the repository.", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "description": "The name of the repository.", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "description": "The full, globally unique, name of the repository.", - "examples": [ - "octocat/Hello-World" - ] + "fixed_at": { + "type": [ + "string", + "null" + ], + "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 + }, + "dismissed_by": { + "anyOf": [ + { + "type": "null" }, - "owner": { + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -86032,98 +83938,518 @@ "type", "url" ] + } + ] + }, + "dismissed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "dismissed_reason": { + "type": [ + "string", + "null" + ], + "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", + "enum": [ + "false positive", + "won't fix", + "used in tests", + null + ] + }, + "dismissed_comment": { + "type": [ + "string", + "null" + ], + "description": "The dismissal comment associated with the dismissal of the alert.", + "maxLength": 280 + }, + "rule": { + "type": "object", + "properties": { + "id": { + "type": [ + "string", + "null" + ], + "description": "A unique identifier for the rule used to detect the alert." }, - "private": { - "type": "boolean", - "description": "Whether the repository is private." - }, - "html_url": { + "name": { "type": "string", - "format": "uri", - "description": "The URL to view the repository on GitHub.com.", - "examples": [ - "https://github.com/octocat/Hello-World" + "description": "The name of the rule used to detect the alert." + }, + "severity": { + "type": [ + "string", + "null" + ], + "description": "The severity of the alert.", + "enum": [ + "none", + "note", + "warning", + "error", + null ] }, - "description": { + "security_severity_level": { "type": [ "string", "null" ], - "description": "The repository description.", - "examples": [ - "This your first repo!" + "description": "The security severity of the alert.", + "enum": [ + "low", + "medium", + "high", + "critical", + null ] }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." + "description": { + "type": "string", + "description": "A short description of the rule used to detect the alert." }, - "url": { + "full_description": { "type": "string", - "format": "uri", - "description": "The URL to get more information about the repository from the GitHub API.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] + "description": "A description of the rule used to detect the alert." }, - "archive_url": { + "tags": { + "type": [ + "array", + "null" + ], + "description": "A set of tags applicable for the rule.", + "items": { + "type": "string" + } + }, + "help": { + "type": [ + "string", + "null" + ], + "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "type": [ + "string", + "null" + ], + "description": "A link to the documentation for the rule used to detect the alert." + } + } + }, + "tool": { + "type": "object", + "properties": { + "name": { "type": "string", - "description": "A template for the API URL to download the repository as an archive.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] + "description": "The name of the tool used to generate the code scanning analysis." }, - "assignees_url": { + "version": { + "type": [ + "string", + "null" + ], + "description": "The version of the tool used to generate the code scanning analysis." + }, + "guid": { + "type": [ + "string", + "null" + ], + "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": "A template for the API URL to list the available assignees for issues in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] + "description": "The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,\n`refs/heads/` or simply ``." }, - "blobs_url": { + "analysis_key": { "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name." }, - "branches_url": { + "environment": { "type": "string", - "description": "A template for the API URL to get information about branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] + "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." }, - "collaborators_url": { + "category": { "type": "string", - "description": "A template for the API URL to get information about collaborators of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + "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", + "null" + ], + "description": "State of a code scanning alert.", + "enum": [ + "open", + "dismissed", + "fixed", + null ] }, - "comments_url": { - "type": "string", - "description": "A template for the API URL to get information about comments on the repository.", + "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", + "null" + ], + "description": "A classification of the file. For example to identify it as generated.", + "enum": [ + "source", + "generated", + "test", + "library", + null + ] + } + } + } + }, + "repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "A unique identifier of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/comments{/number}" + 1296269 ] }, - "commits_url": { + "node_id": { "type": "string", - "description": "A template for the API URL to get information about commits on the repository.", + "description": "The GraphQL identifier of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "compare_url": { + "name": { "type": "string", - "description": "A template for the API URL to compare two commits or refs.", + "description": "The name of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "Hello-World" ] }, - "contents_url": { + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository.", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com.", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description.", + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { "type": "string", "description": "A template for the API URL to get the contents of the repository.", "examples": [ @@ -86381,421 +84707,13 @@ "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/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/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": "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", - "examples": [ - 1 - ] - }, - "name": { - "description": "Automatically generated name of this codespace.", - "type": "string", - "examples": [ - "monalisa-octocat-hello-world-g4wpq6h95q" - ] - }, - "display_name": { - "description": "Display name for this codespace.", - "type": [ - "string", - "null" - ], - "examples": [ - "bookish space pancake" - ] - }, - "environment_id": { - "description": "UUID identifying this codespace's environment.", - "type": [ - "string", - "null" - ], - "examples": [ - "26a7c758-7299-4a73-b978-5a92a7ae98a0" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + }, + "dismissal_approved_by": { + "anyOf": [ + { + "type": "null" }, - "billable_owner": { + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -86962,1241 +84880,83 @@ "type", "url" ] - }, - "repository": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "examples": [ - "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", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# 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", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "type": "object", - "title": "Codespace machine", - "description": "A description of the machine powering a codespace.", - "properties": { - "name": { - "type": "string", - "description": "The name of the machine.", - "examples": [ - "standardLinux" - ] - }, - "display_name": { - "type": "string", - "description": "The display name of the machine includes cores, memory, and storage.", - "examples": [ - "4 cores, 16 GB RAM, 64 GB storage" - ] - }, - "operating_system": { - "type": "string", - "description": "The operating system of the machine.", - "examples": [ - "linux" - ] - }, - "storage_in_bytes": { - "type": "integer", - "description": "How much storage is available to the codespace.", - "examples": [ - 68719476736 - ] - }, - "memory_in_bytes": { - "type": "integer", - "description": "How much memory is available to the codespace.", - "examples": [ - 17179869184 - ] - }, - "cpus": { - "type": "integer", - "description": "How many cores are available to the codespace.", - "examples": [ - 4 - ] - }, - "prebuild_availability": { - "type": [ - "string", - "null" - ], - "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.", - "enum": [ - "none", - "ready", - "in_progress", - null - ], - "examples": [ - "ready" - ] - } - }, - "required": [ - "name", - "display_name", - "operating_system", - "storage_in_bytes", - "memory_in_bytes", - "cpus", - "prebuild_availability" - ] - } - ] - }, - "devcontainer_path": { - "description": "Path to devcontainer.json from repo root used to create Codespace.", - "type": [ - "string", - "null" - ], - "examples": [ - ".devcontainer/example/devcontainer.json" - ] - }, - "prebuild": { - "description": "Whether the codespace was created from a prebuild.", - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "last_used_at": { - "description": "Last known time this codespace was started.", - "type": "string", - "format": "date-time", - "examples": [ - "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" - ], - "type": "string", - "examples": [ - "Available" - ] - }, - "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", - "examples": [ - 0 - ] - }, - "behind": { - "description": "The number of commits the local repository is behind the remote.", - "type": "integer", - "examples": [ - 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", - "examples": [ - "main" - ] - } - } - }, - "location": { - "description": "The initally assigned location of a new codespace.", - "enum": [ - "EastUs", - "SouthEastAsia", - "WestEurope", - "WestUs2" - ], - "type": "string", - "examples": [ - "WestUs2" - ] - }, - "idle_timeout_minutes": { - "description": "The number of minutes of inactivity after which this codespace will be automatically stopped.", - "type": [ - "integer", - "null" - ], - "examples": [ - 60 - ] - }, - "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", - "null" - ], - "format": "uri" - }, - "pulls_url": { - "description": "API URL for the Pull Request associated with this codespace, if any.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "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", - "null" - ], - "items": { - "type": "string" - } - } - } - }, - "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", - "null" - ] - }, - "pending_operation_disabled_reason": { - "description": "Text to show user when codespace is disabled by a pending operation", - "type": [ - "string", - "null" - ] - }, - "idle_timeout_notice": { - "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy", - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ], - "examples": [ - 60 - ] - }, - "retention_expires_at": { - "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T20:01:12Z" - ] - }, - "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", - "null" - ], - "examples": [ - "you've used 100% of your spending limit for Codespaces" - ] } - }, - "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" ] } - } + }, + "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": { - "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 + "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." }, - "billable_owner": { + "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=", @@ -88216,252 +84976,118 @@ "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": [] - }, - { + "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, - "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 + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "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." }, - "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": { + "path": "lib/ab12-gen.js", + "start_line": 917, + "end_line": 917, + "start_column": 7, + "end_column": 18 }, - "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": [] + "classifications": [] }, - { - "id": 1, - "name": "monalisa-octocat-hello-world-f8adfad99a", - "environment_id": "6ac8cd6d-a2d0-4ae3-8cea-e135059264df", + "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, @@ -88482,163 +85108,65 @@ "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": [] + "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" } - ] - } + } + ] } } } - } - }, - "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", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -88663,52 +85191,21 @@ } } }, - "403": { - "description": "Forbidden", + "503": { + "description": "Service unavailable", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { + "code": { "type": "string" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" } } } @@ -88718,23 +85215,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organizations" + "enabledForGitHubApps": true, + "category": "code-scanning", + "subcategory": "code-scanning" } } }, - "/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": { + "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": [ - "codespaces" + "code-security" ], - "operationId": "codespaces/set-codespaces-access", + "operationId": "code-security/get-configurations-for-org", "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#get-code-security-configurations-for-an-organization" }, "parameters": [ { @@ -88745,268 +85242,409 @@ "schema": { "type": "string" } - } - ], - "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": "Response when successfully modifying permissions." }, - "304": { - "description": "Not modified" + { + "name": "target_type", + "in": "query", + "description": "The target type of the code security configuration", + "required": false, + "schema": { + "type": "string", + "enum": [ + "global", + "all" + ], + "default": "all" + } }, - "400": { - "description": "Users are neither members nor collaborators of this organization." + { + "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, + "schema": { + "type": "integer", + "default": 30 + } }, - "404": { - "description": "Resource not found", - "content": { - "application/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": "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" } }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + { + "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" + } + } + ], + "responses": { + "200": { + "description": "Response", "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": "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", - "required": [ - "code" + "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", + "null" ], + "description": "Feature options for code scanning", "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" + "allow_advanced": { + "type": [ + "boolean", + "null" + ], + "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", + "null" + ], + "description": "Feature options for code scanning default setup", + "properties": { + "runner_type": { + "type": [ + "string", + "null" + ], + "enum": [ + "standard", + "labeled", + "not_set", + null + ], + "description": "Whether to use labeled runners or standard GitHub runners." }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" + "runner_label": { + "type": [ + "string", + "null" + ], + "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" } } } - } - } - } - }, - "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" - } - } - }, - "/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" + "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" + } ] } } } } - } - }, - "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": { @@ -89031,83 +85669,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", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "500": { - "description": "Internal Error", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -89135,23 +85698,22 @@ }, "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.", + "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/delete-codespaces-access-users", + "operationId": "code-security/create-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#create-a-code-security-configuration" }, - "deprecated": true, "parameters": [ { "name": "org", @@ -89169,27 +85731,293 @@ "application/json": { "schema": { "type": "object", + "additionalProperties": false, "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 + "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", + "null" + ], + "description": "Security Configuration feature options for code scanning", + "properties": { + "allow_advanced": { + "type": [ + "boolean", + "null" + ], + "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", + "null" + ], + "description": "Feature options for code scanning default setup", + "properties": { + "runner_type": { + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "type": [ + "string", + "null" + ], + "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": [ - "selected_usernames" + "name", + "description" ] }, "examples": { "default": { + "summary": "Example for a code security configuration", "value": { - "selected_usernames": [ - "johnDoe", - "atomIO" - ] + "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" } } } @@ -89197,136 +86025,322 @@ } }, "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", + "201": { + "description": "Successfully created code security configuration", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", + "description": "A code security configuration", "properties": { - "message": { - "type": "string" + "id": { + "type": "integer", + "description": "The ID of the code security configuration" }, - "documentation_url": { - "type": "string" + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." }, - "url": { - "type": "string" + "target_type": { + "type": "string", + "description": "The type of the code security configuration.", + "enum": [ + "global", + "organization", + "enterprise" + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" + "description": { + "type": "string", + "description": "A description of the code security configuration" }, - "documentation_url": { - "type": "string" + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] + "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", + "null" + ], + "description": "Feature options for code scanning", + "properties": { + "allow_advanced": { + "type": [ + "boolean", + "null" + ], + "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", + "null" + ], + "description": "Feature options for code scanning default setup", + "properties": { + "runner_type": { + "type": [ + "string", + "null" + ], + "enum": [ + "standard", + "labeled", + "not_set", + null + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "type": [ + "string", + "null" + ], + "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" }, - { - "type": [ - "integer", - "null" + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" ] - }, - { - "type": [ - "array", - "null" - ], - "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" + "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" + "type": "string", + "format": "uri", + "description": "The URL of the configuration" }, - "status": { - "type": "string" + "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" } } } @@ -89336,23 +86350,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organizations" + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" } } }, - "/orgs/{org}/codespaces/secrets": { + "/orgs/{org}/code-security/configurations/defaults": { "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.", + "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": [ - "codespaces" + "code-security" ], - "operationId": "codespaces/list-org-secrets", + "operationId": "code-security/get-default-configurations", "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#get-default-code-security-configurations" }, "parameters": [ { @@ -89363,24 +86377,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": { @@ -89389,95 +86385,437 @@ "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": "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" + }, "name": { - "description": "The name of the secret", "type": "string", - "examples": [ - "SECRET_NAME" + "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" ] }, - "created_at": { - "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "description": { "type": "string", - "format": "date-time" + "description": "A description of the code security configuration" }, - "updated_at": { - "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "advanced_security": { "type": "string", - "format": "date-time" + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] }, - "visibility": { - "description": "The type of repositories in the organization that the secret is visible to", + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", "enum": [ - "all", - "private", - "selected" + "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", + "null" ], - "type": "string" + "description": "Feature options for code scanning", + "properties": { + "allow_advanced": { + "type": [ + "boolean", + "null" + ], + "description": "Whether to allow repos which use advanced setup" + } + } }, - "selected_repositories_url": { - "description": "The API URL at which the list of repositories this secret is visible to can be retrieved", + "code_scanning_default_setup": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/ORGANIZATION/codespaces/secrets/SECRET_NAME/repositories" + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": [ + "object", + "null" + ], + "description": "Feature options for code scanning default setup", + "properties": { + "runner_type": { + "type": [ + "string", + "null" + ], + "enum": [ + "standard", + "labeled", + "not_set", + null + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "type": [ + "string", + "null" + ], + "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": [ - "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" - }, - { - "name": "GIST_ID", - "created_at": "2020-01-10T10:59:22Z", - "updated_at": "2020-01-11T11:59:22Z", - "visibility": "all" + "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" } - ] + }, + { + "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" + } + } + ] + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "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" + } + } } } } @@ -89485,23 +86823,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organization-secrets" + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" } } }, - "/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.", + "/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/get-org-public-key", + "operationId": "code-security/detach-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key" + "url": "https://docs.github.com/rest/code-security/configurations#detach-configurations-from-repositories" }, "parameters": [ { @@ -89514,65 +86852,184 @@ } } ], + "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 + ] + } + } + } + } + } + }, "responses": { - "200": { - "description": "Response", + "204": { + "description": "A header with no content is returned." + }, + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { - "title": "CodespacesPublicKey", - "description": "The public key used for setting Codespaces secrets.", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "key_id": { - "description": "The identifier for the key.", - "type": "string", - "examples": [ - "1234567" - ] + "message": { + "type": "string" }, - "key": { - "description": "The Base64 encoded public key.", - "type": "string", - "examples": [ - "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" - ] + "documentation_url": { + "type": "string" }, - "id": { - "type": "integer", - "examples": [ - 2 + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" ] }, - "url": { - "type": "string", - "examples": [ - "https://api.github.com/user/keys/2" + "documentation_url": { + "type": [ + "string", + "null" ] }, - "title": { - "type": "string", - "examples": [ - "ssh-rsa AAAAB3NzaC1yc2EAAA" + "detail": { + "type": [ + "string", + "null" ] }, - "created_at": { - "type": "string", - "examples": [ - "2011-01-26T19:01:12Z" + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } } - }, - "required": [ - "key_id", - "key" - ] - }, - "examples": { - "default": { - "value": { - "key_id": "012345678912345678", - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + } + } + } + } + }, + "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" } } } @@ -89582,23 +87039,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}": { + "/orgs/{org}/code-security/configurations/{configuration_id}": { "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.", + "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/get-org-secret", + "operationId": "code-security/get-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#get-a-code-security-configuration" }, "parameters": [ { @@ -89611,12 +87068,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" } } ], @@ -89626,69 +87083,374 @@ "content": { "application/json": { "schema": { - "title": "Codespaces Secret", - "description": "Secrets for a GitHub Codespace.", "type": "object", + "description": "A code security configuration", "properties": { + "id": { + "type": "integer", + "description": "The ID of the code security configuration" + }, "name": { - "description": "The name of the secret", "type": "string", - "examples": [ - "SECRET_NAME" + "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" ] }, - "created_at": { - "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "description": { "type": "string", - "format": "date-time" + "description": "A description of the code security configuration" }, - "updated_at": { - "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "advanced_security": { "type": "string", - "format": "date-time" + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] }, - "visibility": { - "description": "The type of repositories in the organization that the secret is visible to", + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", "enum": [ - "all", - "private", - "selected" + "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", + "null" ], - "type": "string" + "description": "Feature options for code scanning", + "properties": { + "allow_advanced": { + "type": [ + "boolean", + "null" + ], + "description": "Whether to allow repos which use advanced setup" + } + } }, - "selected_repositories_url": { - "description": "The API URL at which the list of repositories this secret is visible to can be retrieved", + "code_scanning_default_setup": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/ORGANIZATION/codespaces/secrets/SECRET_NAME/repositories" + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": [ + "object", + "null" + ], + "description": "Feature options for code scanning default setup", + "properties": { + "runner_type": { + "type": [ + "string", + "null" + ], + "enum": [ + "standard", + "labeled", + "not_set", + null + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "type": [ + "string", + "null" + ], + "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": [ - "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" + "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" } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", + } + }, + "304": { + "description": "Not modified" + }, + "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" + } + } } } } @@ -89696,21 +87458,21 @@ }, "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/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.", + "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/create-or-update-org-secret", + "operationId": "code-security/update-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret" + "url": "https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration" }, "parameters": [ { @@ -89723,12 +87485,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" } } ], @@ -89738,47 +87500,255 @@ "application/json": { "schema": { "type": "object", + "additionalProperties": false, "properties": { - "encrypted_value": { + "name": { "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})$" + "description": "The name of the code security configuration. Must be unique within the organization." }, - "key_id": { + "description": { "type": "string", - "description": "The ID of the key you used to encrypt the secret." + "description": "A description of the code security configuration", + "maxLength": 255 }, - "visibility": { + "advanced_security": { "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 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": [ - "all", - "private", - "selected" + "enabled", + "disabled", + "code_security", + "secret_protection" ] }, - "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" + "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", + "null" + ], + "description": "Feature options for code scanning default setup", + "properties": { + "runner_type": { + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "type": [ + "string", + "null" + ], + "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" + ] } - }, - "required": [ - "visibility" - ] + } }, "examples": { "default": { + "summary": "Example for updating a code security configuration", "value": { - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678", - "visibility": "selected", - "selected_repository_ids": [ - 1296269, - 1296280 - ] + "name": "octo-org recommended settings v2", + "secret_scanning": "disabled", + "code_scanning_default_setup": "enabled" } } } @@ -89786,27 +87756,467 @@ } }, "responses": { - "201": { - "description": "Response when creating a secret", + "200": { + "description": "Response when a configuration is updated", "content": { "application/json": { "schema": { - "title": "Empty Object", - "description": "An object without any properties.", "type": "object", - "properties": {}, - "additionalProperties": false + "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", + "null" + ], + "description": "Feature options for code scanning", + "properties": { + "allow_advanced": { + "type": [ + "boolean", + "null" + ], + "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", + "null" + ], + "description": "Feature options for code scanning default setup", + "properties": { + "runner_type": { + "type": [ + "string", + "null" + ], + "enum": [ + "standard", + "labeled", + "not_set", + null + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "type": [ + "string", + "null" + ], + "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": null + "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" + } } } } } }, "204": { - "description": "Response when updating a secret" + "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": { + "application/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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "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", @@ -89834,18 +88244,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" @@ -89853,56 +88259,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", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } @@ -89912,21 +88273,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": [ { @@ -89939,40 +88302,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 } } } @@ -89981,23 +88377,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": [ { @@ -90010,76 +88406,574 @@ } }, { - "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" } } ], + "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": "Response", + "description": "Default successfully changed.", "content": { "application/json": { "schema": { "type": "object", - "required": [ - "total_count", - "repositories" - ], "properties": { - "total_count": { - "type": "integer" + "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" + ] }, - "repositories": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] + "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", + "null" + ], + "description": "Feature options for code scanning", + "properties": { + "allow_advanced": { + "type": [ + "boolean", + "null" + ], + "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", + "null" + ], + "description": "Feature options for code scanning default setup", + "properties": { + "runner_type": { + "type": [ + "string", + "null" + ], + "enum": [ + "standard", + "labeled", + "not_set", + null + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "type": [ + "string", + "null" + ], + "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", + "description": "A unique identifier of the repository.", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository.", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] }, "name": { "type": "string", + "description": "The name of the repository.", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", + "description": "The full, globally unique, name of the repository.", "examples": [ "octocat/Hello-World" ] @@ -90253,11 +89147,13 @@ ] }, "private": { - "type": "boolean" + "type": "boolean", + "description": "Whether the repository is private." }, "html_url": { "type": "string", "format": "uri", + "description": "The URL to view the repository on GitHub.com.", "examples": [ "https://github.com/octocat/Hello-World" ] @@ -90267,596 +89163,287 @@ "string", "null" ], + "description": "The repository description.", "examples": [ "This your first repo!" ] }, "fork": { - "type": "boolean" + "type": "boolean", + "description": "Whether the repository is a fork." }, "url": { "type": "string", "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API.", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", + "description": "A template for the API URL to download the repository as an archive.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", + "description": "A template for the API URL to get information about branches in the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", + "description": "A template for the API URL to get information about comments on the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + "https://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", + "description": "A template for the API URL to get information about commits on the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", + "description": "A template for the API URL to compare two commits or refs.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", + "description": "A template for the API URL to get the contents of the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", + "description": "A template for the API URL to list the contributors to the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" + "https://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", + "description": "The API URL to list the deployments of the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" + "https://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", + "description": "The API URL to list the downloads on the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" + "https://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", + "description": "The API URL to list the events of the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" + "https://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", + "description": "The API URL to list the forks of the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" + "https://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, - "git_url": { - "type": "string" - }, "issue_comment_url": { "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", + "description": "A template for the API URL to get information about issue events on the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", + "description": "A template for the API URL to get information about issues on the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + "https://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", + "description": "A template for the API URL to get information about labels of the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + "https://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", + "description": "The API URL to get information about the languages of the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" + "https://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", + "description": "The API URL to merge branches in the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" + "https://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", + "description": "A template for the API URL to get information about milestones of the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", + "description": "A template for the API URL to get information about notifications on the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", + "description": "A template for the API URL to get information about releases on the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + "https://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, - "ssh_url": { - "type": "string" - }, "stargazers_url": { "type": "string", "format": "uri", + "description": "The API URL to list the stargazers on the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" + "https://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", + "description": "A template for the API URL to get information about statuses of a commit.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", + "description": "The API URL to list the subscribers on the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" + "https://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", + "description": "The API URL to subscribe to notifications for this repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" + "https://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", + "description": "The API URL to get information about tags on the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" + "https://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", + "description": "The API URL to list the teams on the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" + "https://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" + "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "hooks_url": { "type": "string", "format": "uri", + "description": "The API URL to list the hooks on the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "examples": [ - "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", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# 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", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false + "https://api.github.com/repos/octocat/Hello-World/hooks" ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "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": [ @@ -90913,87 +89500,90 @@ }, "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" + "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" + } } - ] - } + } + ] } } } } }, - "404": { - "description": "Resource not found", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -91017,80 +89607,6 @@ } } } - } - }, - "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", @@ -91117,662 +89633,480 @@ } } } - }, - "409": { - "description": "Conflict when visibility type not set to selected" } }, "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/{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.", + "/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/add-selected-repo-to-org-secret", + "operationId": "codespaces/list-in-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret" + "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 } }, { - "name": "secret_name", - "description": "The name of the secret.", - "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": "string" + "type": "integer", + "default": 1 } }, { - "name": "repository_id", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], "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.", + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", "type": "object", "required": [ - "message", - "documentation_url" + "total_count", + "codespaces" ], "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + "total_count": { + "type": "integer" }, - "errors": { + "codespaces": { "type": "array", "items": { "type": "object", - "required": [ - "code" - ], + "title": "Codespace", + "description": "A codespace.", "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] }, - "message": { - "type": "string" + "name": { + "description": "Automatically generated name of this codespace.", + "type": "string", + "examples": [ + "monalisa-octocat-hello-world-g4wpq6h95q" + ] }, - "code": { - "type": "string" + "display_name": { + "description": "Display name for this codespace.", + "type": [ + "string", + "null" + ], + "examples": [ + "bookish space pancake" + ] }, - "index": { - "type": "integer" + "environment_id": { + "description": "UUID identifying this codespace's environment.", + "type": [ + "string", + "null" + ], + "examples": [ + "26a7c758-7299-4a73-b978-5a92a7ae98a0" + ] }, - "value": { - "oneOf": [ - { + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { "type": [ "string", "null" ] }, - { + "email": { "type": [ - "integer", + "string", "null" ] }, - { + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { "type": [ - "array", + "string", "null" ], - "items": { - "type": "string" - } + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] - } - } - } - } - } - } - } - } - } - }, - "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" - }, - "value": { - "oneOf": [ - { + "billable_owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { "type": [ "string", "null" ] }, - { + "email": { "type": [ - "integer", + "string", "null" ] }, - { + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { "type": [ - "array", + "string", "null" ], - "items": { - "type": "string" - } + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] - } - } - } - } - } - } - } - } - } - }, - "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" - } - } - } - } - } - }, - "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 \"[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.", - "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": { - "anyOf": [ - { - "type": "null" + }, + "repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] }, - { + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -91939,464 +90273,1009 @@ "type", "url" ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" }, - { - "title": "Organization Simple", - "description": "A GitHub organization.", + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { "type": "object", "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] + "admin": { + "type": "boolean" }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] + "maintain": { + "type": "boolean" }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] + "push": { + "type": "boolean" }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] + "triage": { + "type": "boolean" }, - "issues_url": { + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "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", "examples": [ - "https://api.github.com/orgs/github/issues" + "contributor_covenant" ] }, - "members_url": { + "name": { "type": "string", "examples": [ - "https://api.github.com/orgs/github/members{/member}" + "Contributor Covenant" ] }, - "public_members_url": { + "url": { "type": "string", + "format": "uri", "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" + "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, - "avatar_url": { + "body": { "type": "string", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "# 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" ] }, - "description": { + "html_url": { "type": [ "string", "null" ], - "examples": [ - "A great organization" - ] + "format": "uri" } }, "required": [ - "login", "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" + "html_url", + "key", + "name" ] - } - ] - }, - "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", + }, + "license": { + "type": [ + "object", + "null" + ], "properties": { - "id": { - "type": "integer" - }, - "node_id": { + "key": { "type": "string" }, "name": { "type": "string" }, - "slug": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "privacy": { + "spdx_id": { "type": "string" }, - "notification_setting": { + "url": { "type": "string" }, - "permission": { + "node_id": { "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "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" + ] + } + } }, - "permissions": { + "code_security": { "type": "object", "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] + } }, - "url": { - "type": "string", - "format": "uri" + "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" + ] + } + } }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } }, - "members_url": { - "type": "string" + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } }, - "repositories_url": { - "type": "string", - "format": "uri" + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" ] } - ] + } } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] + } + }, + "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": { + "anyOf": [ + { + "type": "null" }, { - "title": "Enterprise Team", - "description": "Group of enterprise owners and/or members", "type": "object", + "title": "Codespace machine", + "description": "A description of the machine powering a codespace.", "properties": { - "id": { - "type": "integer", - "format": "int64" - }, "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "url": { "type": "string", - "format": "uri" + "description": "The name of the machine.", + "examples": [ + "standardLinux" + ] }, - "sync_to_organizations": { + "display_name": { "type": "string", + "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ - "disabled | all" + "4 cores, 16 GB RAM, 64 GB storage" ] }, - "organization_selection_type": { + "operating_system": { "type": "string", + "description": "The operating system of the machine.", "examples": [ - "disabled | all" + "linux" ] }, - "group_id": { - "type": [ - "string", - "null" - ], + "storage_in_bytes": { + "type": "integer", + "description": "How much storage is available to the codespace.", "examples": [ - "62ab9291-fae2-468e-974b-7e45096d5021" + 68719476736 ] }, - "group_name": { - "type": [ - "string", - "null" - ], + "memory_in_bytes": { + "type": "integer", + "description": "How much memory is available to the codespace.", "examples": [ - "Justice League" + 17179869184 ] }, - "html_url": { - "type": "string", - "format": "uri", + "cpus": { + "type": "integer", + "description": "How many cores are available to the codespace.", "examples": [ - "https://github.com/enterprises/dc/teams/justice-league" + 4 ] }, - "members_url": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" + "prebuild_availability": { + "type": [ + "string", + "null" + ], + "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.", + "enum": [ + "none", + "ready", + "in_progress", + null + ], + "examples": [ + "ready" + ] } }, "required": [ - "id", - "url", - "members_url", "name", - "html_url", - "slug", - "created_at", - "updated_at" + "display_name", + "operating_system", + "storage_in_bytes", + "memory_in_bytes", + "cpus", + "prebuild_availability" ] } - ], - "type": [ - "null", - "object" ] }, - "pending_cancellation_date": { - "type": [ - "string", - "null" - ], - "format": "date", - "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": { + "devcontainer_path": { + "description": "Path to devcontainer.json from repo root used to create Codespace.", "type": [ "string", "null" ], - "format": "date-time", - "description": "Timestamp of user's last GitHub Copilot activity, in ISO 8601 format." + "examples": [ + ".devcontainer/example/devcontainer.json" + ] }, - "last_activity_editor": { + "prebuild": { + "description": "Whether the codespace was created from a prebuild.", "type": [ - "string", + "boolean", "null" ], - "description": "Last editor that was used by the user for a GitHub Copilot completion." + "examples": [ + false + ] }, "created_at": { "type": "string", "format": "date-time", - "description": "Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format." + "examples": [ + "2011-01-26T19:01:12Z" + ] }, "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." + "examples": [ + "2011-01-26T19:01:12Z" + ] }, - "plan_type": { + "last_used_at": { + "description": "Last known time this codespace was started.", "type": "string", - "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "state": { + "description": "State of this codespace.", "enum": [ - "business", - "enterprise", - "unknown" + "Unknown", + "Created", + "Queued", + "Provisioning", + "Available", + "Awaiting", + "Unavailable", + "Deleted", + "Moved", + "Shutdown", + "Archived", + "Starting", + "ShuttingDown", + "Failed", + "Exporting", + "Updating", + "Rebuilding" + ], + "type": "string", + "examples": [ + "Available" + ] + }, + "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", + "examples": [ + 0 + ] + }, + "behind": { + "description": "The number of commits the local repository is behind the remote.", + "type": "integer", + "examples": [ + 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", + "examples": [ + "main" + ] + } + } + }, + "location": { + "description": "The initally assigned location of a new codespace.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], + "type": "string", + "examples": [ + "WestUs2" + ] + }, + "idle_timeout_minutes": { + "description": "The number of minutes of inactivity after which this codespace will be automatically stopped.", + "type": [ + "integer", + "null" + ], + "examples": [ + 60 + ] + }, + "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", + "null" + ], + "format": "uri" + }, + "pulls_url": { + "description": "API URL for the Pull Request associated with this codespace, if any.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "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", + "null" + ], + "items": { + "type": "string" + } + } + } + }, + "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", + "null" + ] + }, + "pending_operation_disabled_reason": { + "description": "Text to show user when codespace is disabled by a pending operation", + "type": [ + "string", + "null" + ] + }, + "idle_timeout_notice": { + "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy", + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ], + "examples": [ + 60 + ] + }, + "retention_expires_at": { + "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T20:01:12Z" + ] + }, + "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", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" ] } }, "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" + ] } } } @@ -92404,16 +91283,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=", @@ -92433,64 +91309,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": { @@ -92598,23 +91831,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": [ { @@ -92627,95 +91860,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": { @@ -92740,14 +91941,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" @@ -92755,19 +91960,64 @@ "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } } } } } } }, - "404": { - "description": "Resource not found", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -92791,28 +92041,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": [ { @@ -92825,95 +92074,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": { @@ -92938,14 +92144,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" @@ -92953,19 +92163,64 @@ "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } } } } } } }, - "404": { - "description": "Resource not found", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -92989,31 +92244,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", @@ -93026,6 +92277,7 @@ } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { @@ -93033,11 +92285,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": [ @@ -93048,72 +92300,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": { @@ -93138,14 +92345,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" @@ -93153,19 +92364,64 @@ "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } } } } } } }, - "404": { - "description": "Resource not found", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -93189,28 +92445,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": [ { @@ -93221,196 +92476,354 @@ "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" + }, + "secrets": { + "type": "array", + "items": { + "title": "Codespaces Secret", + "description": "Secrets for a GitHub Codespace.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret", + "type": "string", + "examples": [ + "SECRET_NAME" + ] + }, + "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", + "examples": [ + "https://api.github.com/orgs/ORGANIZATION/codespaces/secrets/SECRET_NAME/repositories" + ] + } + }, + "required": [ + "name", + "created_at", + "updated_at", + "visibility" + ] + } } - }, - "required": [ - "seats_cancelled" - ] + } }, "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", + "examples": [ + "1234567" + ] }, - "documentation_url": { - "type": "string" + "key": { + "description": "The Base64 encoded public key.", + "type": "string", + "examples": [ + "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" + ] + }, + "id": { + "type": "integer", + "examples": [ + 2 + ] }, "url": { - "type": "string" + "type": "string", + "examples": [ + "https://api.github.com/user/keys/2" + ] }, - "status": { - "type": "string" + "title": { + "type": "string", + "examples": [ + "ssh-rsa AAAAB3NzaC1yc2EAAA" + ] + }, + "created_at": { + "type": "string", + "examples": [ + "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": { - "type": "string" + "name": { + "description": "The name of the secret", + "type": "string", + "examples": [ + "SECRET_NAME" + ] }, - "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", + "examples": [ + "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": [ { @@ -93423,554 +92836,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", - "null" - ], - "description": "Usage metrics for Copilot editor code completions in the IDE.", - "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", - "null" - ], - "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", - "null" - ], - "description": "Usage metrics for Copilot Chat in the IDE.", - "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", - "null" - ], - "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", - "null" - ], - "description": "Usage metrics for Copilot Chat in GitHub.com", - "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", - "null" - ], - "description": "The training date for the custom model (if applicable)." - }, - "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", - "null" - ], - "description": "Usage metrics for Copilot for pull requests.", - "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", - "null" - ], - "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": { @@ -93995,14 +92947,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" @@ -94010,19 +92966,107 @@ "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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": { @@ -94050,23 +93094,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": [ { @@ -94079,145 +93123,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 } }, { @@ -94236,1256 +93156,820 @@ "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", + "required": [ + "total_count", + "repositories" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "repositories": { + "type": "array", + "items": { + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", - "description": "Details for the vulnerable dependency.", - "readOnly": true, "properties": { - "package": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, "properties": { - "ecosystem": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true + "examples": [ + "octocat" + ] }, - "name": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } }, "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, - "manifest_path": { + "private": { + "type": "boolean" + }, + "html_url": { "type": "string", - "description": "The full path to the dependency manifest file, relative to the root of the repository.", - "readOnly": true + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] }, - "scope": { + "description": { "type": [ "string", "null" ], - "description": "The execution scope of the vulnerable dependency.", - "readOnly": true, - "enum": [ - "development", - "runtime", - null + "examples": [ + "This your first repo!" ] }, - "relationship": { - "type": [ - "string", - "null" - ], - "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, - "enum": [ - "unknown", - "direct", - "transitive", - null + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" ] - } - } - }, - "security_advisory": { - "type": "object", - "description": "Details for the GitHub Security Advisory.", - "readOnly": true, - "properties": { - "ghsa_id": { + }, + "archive_url": { "type": "string", - "description": "The unique GitHub Security Advisory ID assigned to the advisory.", - "readOnly": true + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] }, - "cve_id": { - "type": [ - "string", - "null" - ], - "description": "The unique CVE ID assigned to the advisory.", - "readOnly": true + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] }, - "summary": { + "blobs_url": { "type": "string", - "description": "A short, plain text summary of the advisory.", - "readOnly": true, - "maxLength": 1024 + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] }, - "description": { + "branches_url": { "type": "string", - "description": "A long-form Markdown-supported description of the advisory.", - "readOnly": true + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] }, - "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", - "null" - ], - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": 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 - } + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] }, - "severity": { + "comments_url": { "type": "string", - "description": "The severity of the advisory.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, - "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", - "null" - ], - "description": "The full CVSS vector string for the advisory.", - "readOnly": true - } - }, - "required": [ - "score", - "vector_string" - ], - "additionalProperties": false - }, - "cvss_severities": { - "type": [ - "object", - "null" - ], - "properties": { - "cvss_v3": { - "type": [ - "object", - "null" - ], - "properties": { - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The CVSS 3 vector string." - }, - "score": { - "type": [ - "number", - "null" - ], - "description": "The CVSS 3 score.", - "minimum": 0, - "maximum": 10, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - }, - "cvss_v4": { - "type": [ - "object", - "null" - ], - "properties": { - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The CVSS 4 vector string." - }, - "score": { - "type": [ - "number", - "null" - ], - "description": "The CVSS 4 score.", - "minimum": 0, - "maximum": 10, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - } - } - }, - "epss": { - "type": [ - "object", - "null" - ], - "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", - "null" - ], - "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": 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", - "null" - ], - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": 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", - "null" - ], - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "dismissed_reason": { - "type": [ - "string", - "null" - ], - "description": "The reason that the alert was dismissed.", - "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk", - null - ] - }, - "dismissed_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment associated with the alert's dismissal.", - "maxLength": 280 - }, - "fixed_at": { - "type": [ - "string", - "null" - ], - "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 - }, - "auto_dismissed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "repository": { - "title": "Simple Repository", - "description": "A GitHub repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "A unique identifier of the repository.", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "description": "The GraphQL identifier of the repository.", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "description": "The name of the repository.", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "description": "The full, globally unique, name of the repository.", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean", - "description": "Whether the repository is private." - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL to view the repository on GitHub.com.", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The repository description.", - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL to get more information about the repository from the GitHub API.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "description": "A template for the API URL to download the repository as an archive.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "description": "A template for the API URL to list the available assignees for issues in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "description": "A template for the API URL to get information about branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "description": "A template for the API URL to get information about collaborators of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "description": "A template for the API URL to get information about comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "description": "A template for the API URL to get information about commits on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] }, "compare_url": { "type": "string", - "description": "A template for the API URL to compare two commits or refs.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", - "description": "A template for the API URL to get the contents of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", - "description": "A template for the API URL to list the contributors to the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contributors" + "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", - "description": "The API URL to list the deployments of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/deployments" + "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", - "description": "The API URL to list the downloads on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/downloads" + "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", - "description": "The API URL to list the events of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/events" + "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", - "description": "The API URL to list the forks of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/forks" + "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", - "description": "A template for the API URL to get information about Git commits of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", - "description": "A template for the API URL to get information about Git refs of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", - "description": "A template for the API URL to get information about Git tags of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, + "git_url": { + "type": "string" + }, "issue_comment_url": { "type": "string", - "description": "A template for the API URL to get information about issue comments on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", - "description": "A template for the API URL to get information about issue events on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", - "description": "A template for the API URL to get information about issues on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues{/number}" + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", - "description": "A template for the API URL to get information about deploy keys on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", - "description": "A template for the API URL to get information about labels of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/labels{/name}" + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", - "description": "The API URL to get information about the languages of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/languages" + "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", - "description": "The API URL to merge branches in the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/merges" + "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", - "description": "A template for the API URL to get information about milestones of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", - "description": "A template for the API URL to get information about notifications on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", - "description": "A template for the API URL to get information about pull requests on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", - "description": "A template for the API URL to get information about releases on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/releases{/id}" + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, + "ssh_url": { + "type": "string" + }, "stargazers_url": { "type": "string", "format": "uri", - "description": "The API URL to list the stargazers on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/stargazers" + "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", - "description": "A template for the API URL to get information about statuses of a commit.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", - "description": "The API URL to list the subscribers on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscribers" + "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", - "description": "The API URL to subscribe to notifications for this repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscription" + "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", - "description": "The API URL to get information about tags on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/tags" + "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", - "description": "The API URL to list the teams on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/teams" + "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" ] }, "hooks_url": { "type": "string", "format": "uri", - "description": "The API URL to list the hooks on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks" + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "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", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# 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", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "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": [ @@ -95537,431 +94021,92 @@ "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", + "value": { + "total_count": 1, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", "owner": { - "login": "octo-org", - "id": 6811672, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", - "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", "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", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "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": true, - "html_url": "https://github.com/octo-org/hello-world", - "description": null, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", "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}" + "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" } - } - ] + ] + } } } } } }, - "304": { - "description": "Not modified" - }, - "400": { - "description": "Bad Request", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -95983,53 +94128,85 @@ } } } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": [ - "string", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { + } + } + } + }, + "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" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } } } + }, + "required": [ + "selected_repository_ids" + ] + }, + "examples": { + "default": { + "value": { + "selected_repository_ids": [ + 64780797 + ] + } } } } + } + }, + "responses": { + "204": { + "description": "Response" }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -96054,6 +94231,62 @@ } } }, + "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": { @@ -96080,13 +94313,16 @@ } } }, + "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 Simple", - "description": "Validation Error Simple", + "title": "Validation Error", + "description": "Validation Error", "type": "object", "required": [ "message", @@ -96102,7 +94338,52 @@ "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } } } } @@ -96113,23 +94394,21 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "alerts" + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" } - } - }, - "/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.", + }, + "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": [ - "dependabot" + "codespaces" ], - "operationId": "dependabot/list-org-secrets", + "operationId": "codespaces/remove-selected-repo-from-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#list-organization-secrets" + "url": "https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret" }, "parameters": [ { @@ -96142,147 +94421,151 @@ } }, { - "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": "secret_name", + "description": "The name of the secret.", + "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": "repository_id", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" } } ], "responses": { - "200": { - "description": "Response", + "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": [ - "total_count", - "secrets" + "message", + "documentation_url" ], "properties": { - "total_count": { - "type": "integer" + "message": { + "type": "string" }, - "secrets": { + "documentation_url": { + "type": "string" + }, + "errors": { "type": "array", "items": { - "title": "Dependabot Secret for an Organization", - "description": "Secrets for GitHub Dependabot for an organization.", "type": "object", + "required": [ + "code" + ], "properties": { - "name": { - "description": "The name of the secret.", - "type": "string", - "examples": [ - "SECRET_TOKEN" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" + "resource": { + "type": "string" }, - "updated_at": { - "type": "string", - "format": "date-time" + "field": { + "type": "string" }, - "visibility": { - "description": "Visibility of a secret", - "enum": [ - "all", - "private", - "selected" - ], + "message": { "type": "string" }, - "selected_repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories" + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } ] } - }, - "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" + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" } } }, - "/orgs/{org}/dependabot/secrets/public-key": { + "/orgs/{org}/copilot/billing": { "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.", + "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": [ - "dependabot" + "copilot" ], - "operationId": "dependabot/get-org-public-key", + "operationId": "copilot/get-copilot-organization-details", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key" + "url": "https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization" }, "parameters": [ { @@ -96297,327 +94580,257 @@ ], "responses": { "200": { - "description": "Response", + "description": "OK", "content": { "application/json": { "schema": { - "title": "DependabotPublicKey", - "description": "The public key used for setting Dependabot Secrets.", + "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": { - "key_id": { - "description": "The identifier for the key.", + "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", - "examples": [ - "1234567" + "description": "The organization policy for allowing or blocking suggestions matching public code (duplication detection filter).", + "enum": [ + "allow", + "block", + "unconfigured" ] }, - "key": { - "description": "The Base64 encoded public key.", + "ide_chat": { "type": "string", - "examples": [ - "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" + "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": [ - "key_id", - "key" - ] + "seat_breakdown", + "public_code_suggestions", + "seat_management_setting" + ], + "additionalProperties": true }, "examples": { "default": { "value": { - "key_id": "012345678912345678", - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + "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" } } } } } - } - }, - "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", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { - "title": "Dependabot Secret for an Organization", - "description": "Secrets for GitHub Dependabot for an organization.", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "name": { - "description": "The name of the secret.", - "type": "string", - "examples": [ - "SECRET_TOKEN" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" + "message": { + "type": "string" }, - "updated_at": { - "type": "string", - "format": "date-time" + "documentation_url": { + "type": "string" }, - "visibility": { - "description": "Visibility of a secret", - "enum": [ - "all", - "private", - "selected" - ], + "url": { "type": "string" }, - "selected_repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "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" + "status": { + "type": "string" } } } } } - } - }, - "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": { + "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": [ - "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" - } - }, - "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" + "404": { + "description": "Resource not found", + "content": { + "application/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" - } - } - ], - "responses": { - "204": { - "description": "Response" + "422": { + "description": "There is a problem with your account's associated payment method." } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" + "category": "copilot", + "subcategory": "copilot-user-management" } } }, - "/orgs/{org}/dependabot/secrets/{secret_name}/repositories": { + "/orgs/{org}/copilot/billing/seats": { "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": "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": [ - "dependabot" + "copilot" ], - "operationId": "dependabot/list-selected-repos-for-org-secret", + "operationId": "copilot/list-copilot-seats", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret" + "url": "https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization" }, "parameters": [ { @@ -96629,15 +94842,6 @@ "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).\"", @@ -96653,7 +94857,7 @@ "in": "query", "schema": { "type": "integer", - "default": 30 + "default": 50 } } ], @@ -96664,1450 +94868,24 @@ "application/json": { "schema": { "type": "object", - "required": [ - "total_count", - "repositories" - ], "properties": { - "total_count": { - "type": "integer" + "total_seats": { + "type": "integer", + "description": "Total number of Copilot seats for the organization currently being billed." }, - "repositories": { + "seats": { "type": "array", "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", + "title": "Copilot Business Seat Detail", + "description": "Information about a Copilot Business seat assignment for a user, team, or organization.", "type": "object", "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "examples": [ - "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", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# 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", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "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" - } - ] - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "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/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": [ - "dependabot" - ], - "operationId": "dependabot/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" - }, - "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/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" - } - } - }, - "required": [ - "selected_repository_ids" - ] - }, - "examples": { - "default": { - "value": { - "selected_repository_ids": [ - 64780797 - ] - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" - } - } - }, - "/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": [ - "dependabot" - ], - "operationId": "dependabot/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" - }, - "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": "dependabot", - "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/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": [ - "dependabot" - ], - "operationId": "dependabot/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" - }, - "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": "dependabot", - "subcategory": "secrets" - } - } - }, - "/orgs/{org}/docker/conflicts": { - "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.", - "tags": [ - "packages" - ], - "operationId": "packages/list-docker-migration-conflicting-packages-for-organization", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-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": { - "type": "array", - "items": { - "title": "Package", - "description": "A software package", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the package.", - "type": "integer", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the package.", - "type": "string", - "examples": [ - "super-linter" - ] - }, - "package_type": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ], - "examples": [ - "docker" - ] - }, - "url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/packages/container/super-linter" - ] - }, - "html_url": { - "type": "string", - "examples": [ - "https://github.com/orgs/github/packages/container/package/super-linter" - ] - }, - "version_count": { - "description": "The number of versions of the package.", - "type": "integer", - "examples": [ - 1 - ] - }, - "visibility": { - "type": "string", - "enum": [ - "private", - "public" - ], - "examples": [ - "private" - ] - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "repository": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] + "assignee": { + "anyOf": [ + { + "type": "null" }, - "owner": { + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -98274,758 +95052,1205 @@ "type", "url" ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { + { + "title": "Organization Simple", + "description": "A GitHub organization.", "type": "object", "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" + "login": { + "type": "string", + "examples": [ + "github" + ] }, - "push": { - "type": "boolean" + "id": { + "type": "integer", + "examples": [ + 1 + ] }, - "triage": { - "type": "boolean" + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "examples": [ - "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": { + "url": { "type": "string", + "format": "uri", "examples": [ - "contributor_covenant" + "https://api.github.com/orgs/github" ] }, - "name": { + "repos_url": { "type": "string", + "format": "uri", "examples": [ - "Contributor Covenant" + "https://api.github.com/orgs/github/repos" ] }, - "url": { + "events_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" + "https://api.github.com/orgs/github/events" ] }, - "body": { + "hooks_url": { "type": "string", "examples": [ - "# 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" + "https://api.github.com/orgs/github/hooks" ] }, - "html_url": { + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { "type": [ "string", "null" ], - "format": "uri" + "examples": [ + "A great organization" + ] } }, "required": [ + "login", "url", - "html_url", - "key", - "name" + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" ] - }, - "license": { - "type": [ - "object", - "null" - ], + } + ] + }, + "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": { - "key": { + "id": { + "type": "integer" + }, + "node_id": { "type": "string" }, "name": { "type": "string" }, - "spdx_id": { + "slug": { "type": "string" }, - "url": { + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { "type": "string" }, - "node_id": { + "notification_setting": { "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "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" - ] - } - } + "permission": { + "type": "string" }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", + "permissions": { "type": "object", "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" } - } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } + "url": { + "type": "string", + "format": "uri" }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } + "members_url": { + "type": "string" }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" ] } - } + ] } - } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] }, - "custom_properties": { + { + "title": "Enterprise Team", + "description": "Group of enterprise owners and/or members", "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": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "sync_to_organizations": { + "type": "string", + "examples": [ + "disabled | all" + ] + }, + "organization_selection_type": { + "type": "string", + "examples": [ + "disabled | all" + ] + }, + "group_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "62ab9291-fae2-468e-974b-7e45096d5021" + ] + }, + "group_name": { + "type": [ + "string", + "null" + ], + "examples": [ + "Justice League" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "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" + ] } - }, - "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" + ], + "type": [ + "null", + "object" + ] + }, + "pending_cancellation_date": { + "type": [ + "string", + "null" + ], + "format": "date", + "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", + "null" + ], + "format": "date-time", + "description": "Timestamp of user's last GitHub Copilot activity, in ISO 8601 format." + }, + "last_activity_editor": { + "type": [ + "string", + "null" + ], + "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" ] } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" + }, + "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" }, - "required": [ - "id", - "name", - "package_type", - "visibility", - "url", - "html_url", - "version_count", - "created_at", - "updated_at" + "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": [ - { - "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" - } + "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": { @@ -99052,6 +96277,152 @@ } } }, + "404": { + "description": "Resource not found", + "content": { + "application/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": { @@ -99077,27 +96448,82 @@ } } } + }, + "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": false, - "category": "packages", - "subcategory": "packages" + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-user-management" } } }, - "/orgs/{org}/events": { + "/orgs/{org}/copilot/metrics": { "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.", + "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": [ - "activity" + "copilot" ], - "operationId": "activity/list-public-org-events", + "operationId": "copilot/copilot-metrics-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/activity/events#list-public-organization-events" + "url": "https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization" }, "parameters": [ { @@ -99110,12 +96536,21 @@ } }, { - "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": "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": "integer", - "default": 30 + "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" } }, { @@ -99126,6 +96561,15 @@ "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": { @@ -99136,3737 +96580,2644 @@ "schema": { "type": "array", "items": { - "title": "Event", - "description": "Event", + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", "type": "object", "properties": { - "id": { - "type": "string" + "date": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." }, - "type": { + "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": [ - "string", + "object", "null" - ] - }, - "actor": { - "title": "Actor", - "description": "Actor", - "type": "object", + ], + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "additionalProperties": true, "properties": { - "id": { - "type": "integer" + "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." }, - "login": { - "type": "string" + "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." + } + } + } }, - "display_login": { - "type": "string" + "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", + "null" + ], + "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", + "null" + ], + "description": "Usage metrics for Copilot Chat in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat in the IDE." }, - "gravatar_id": { - "type": [ - "string", - "null" - ] + "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", + "null" + ], + "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", + "null" + ], + "description": "Usage metrics for Copilot Chat in GitHub.com", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once." }, - "url": { - "type": "string", - "format": "uri" + "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", + "null" + ], + "description": "The training date for the custom model (if applicable)." + }, + "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", + "null" + ], + "description": "Usage metrics for Copilot for pull requests.", + "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." }, - "avatar_url": { - "type": "string", - "format": "uri" + "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", + "null" + ], + "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 + } + }, + "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 + } + ] + } + ] + } + ] }, - "required": [ - "id", - "login", - "gravatar_id", - "url", - "avatar_url" + "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 + } + ] + } + ] + } + } + ] + } + } + } + } + }, + "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": "copilot", + "subcategory": "copilot-metrics" + } + } + }, + "/orgs/{org}/dependabot/alerts": { + "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.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/list-alerts-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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": "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", + "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 + } + } + ], + "responses": { + "200": { + "description": "Response", + "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" ] }, - "repo": { + "dependency": { "type": "object", + "description": "Details for the vulnerable dependency.", + "readOnly": true, "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" + "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 }, - "url": { + "manifest_path": { "type": "string", - "format": "uri" + "description": "The full path to the dependency manifest file, relative to the root of the repository.", + "readOnly": true + }, + "scope": { + "type": [ + "string", + "null" + ], + "description": "The execution scope of the vulnerable dependency.", + "readOnly": true, + "enum": [ + "development", + "runtime", + null + ] + }, + "relationship": { + "type": [ + "string", + "null" + ], + "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, + "enum": [ + "unknown", + "direct", + "transitive", + null + ] } - }, - "required": [ - "id", - "name", - "url" - ] + } }, - "org": { - "title": "Actor", - "description": "Actor", + "security_advisory": { "type": "object", + "description": "Details for the GitHub Security Advisory.", + "readOnly": true, "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "display_login": { - "type": "string" + "ghsa_id": { + "type": "string", + "description": "The unique GitHub Security Advisory ID assigned to the advisory.", + "readOnly": true }, - "gravatar_id": { + "cve_id": { "type": [ "string", "null" + ], + "description": "The unique CVE ID assigned to the advisory.", + "readOnly": 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", + "null" + ], + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": 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" ] }, - "url": { + "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", + "null" + ], + "description": "The full CVSS vector string for the advisory.", + "readOnly": true + } + }, + "required": [ + "score", + "vector_string" + ], + "additionalProperties": false + }, + "cvss_severities": { + "type": [ + "object", + "null" + ], + "properties": { + "cvss_v3": { + "type": [ + "object", + "null" + ], + "properties": { + "vector_string": { + "type": [ + "string", + "null" + ], + "description": "The CVSS 3 vector string." + }, + "score": { + "type": [ + "number", + "null" + ], + "description": "The CVSS 3 score.", + "minimum": 0, + "maximum": 10, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + }, + "cvss_v4": { + "type": [ + "object", + "null" + ], + "properties": { + "vector_string": { + "type": [ + "string", + "null" + ], + "description": "The CVSS 4 vector string." + }, + "score": { + "type": [ + "number", + "null" + ], + "description": "The CVSS 4 score.", + "minimum": 0, + "maximum": 10, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + } + } + }, + "epss": { + "type": [ + "object", + "null" + ], + "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", - "format": "uri" + "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true }, - "avatar_url": { + "updated_at": { "type": "string", - "format": "uri" + "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", + "null" + ], + "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true } }, "required": [ - "id", - "login", - "gravatar_id", - "url", - "avatar_url" - ] + "ghsa_id", + "cve_id", + "summary", + "description", + "vulnerabilities", + "severity", + "cvss", + "cwes", + "identifiers", + "references", + "published_at", + "updated_at", + "withdrawn_at" + ], + "additionalProperties": false }, - "payload": { + "security_vulnerability": { "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, "properties": { - "action": { - "type": "string" + "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 }, - "issue": { - "title": "Issue", - "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "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", + "null" + ], + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": 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", + "null" + ], + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "dismissed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, "id": { "type": "integer", - "format": "int64" + "format": "int64", + "examples": [ + 1 + ] }, "node_id": { - "type": "string" + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] }, "url": { - "description": "URL for the issue", "type": "string", "format": "uri", "examples": [ - "https://api.github.com/repositories/42/issues/1" + "https://api.github.com/users/octocat" ] }, - "repository_url": { + "html_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] }, - "labels_url": { - "type": "string" + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] }, - "comments_url": { + "following_url": { "type": "string", - "format": "uri" + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] }, "events_url": { "type": "string", - "format": "uri" + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] }, - "html_url": { + "received_events_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "type": "integer", + "type": { + "type": "string", "examples": [ - 42 + "User" ] }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", + "site_admin": { + "type": "boolean" + }, + "starred_at": { "type": "string", "examples": [ - "open" + "\"2020-07-09T00:17:55Z\"" ] }, - "state_reason": { - "description": "The reason for the current state", + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "dismissed_reason": { + "type": [ + "string", + "null" + ], + "description": "The reason that the alert was dismissed.", + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk", + null + ] + }, + "dismissed_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment associated with the alert's dismissal.", + "maxLength": 280 + }, + "fixed_at": { + "type": [ + "string", + "null" + ], + "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 + }, + "auto_dismissed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "A unique identifier of the repository.", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository.", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "description": "The name of the repository.", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository.", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { "type": [ "string", "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ], + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", "examples": [ - "not_planned" + "octocat" ] }, - "title": { - "description": "Title of the issue", + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { "type": "string", "examples": [ - "Widget creation fails in Safari on OS X 10.8" + "MDQ6VXNlcjE=" ] }, - "body": { - "description": "Contents of the issue", + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { "type": [ "string", "null" ], "examples": [ - "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?" + "41d064eb2195891e12d0413f63227ea7" ] }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" ] }, - "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", - "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", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - }, + "html_url": { + "type": "string", + "format": "uri", "examples": [ - "bug", - "registration" + "https://github.com/octocat" ] }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" ] }, - "assignees": { - "type": [ - "array", - "null" - ], - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/milestones/v1.0" - ] - }, - "labels_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDk6TWlsZXN0b25lMTAwMjYwNA==" - ] - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "examples": [ - 42 - ] - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open", - "examples": [ - "open" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string", - "examples": [ - "v1.0" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "Tracking milestone for version 1.0" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 4 - ] - }, - "closed_issues": { - "type": "integer", - "examples": [ - 8 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2013-02-12T13:22:01Z" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2012-10-09T23:39:01Z" - ] - } - }, - "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" - ] - } + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "locked": { - "type": "boolean" + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] }, - "active_lock_reason": { - "type": [ - "string", - "null" + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" ] }, - "comments": { - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" ] }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] }, - "created_at": { + "received_events_url": { "type": "string", - "format": "date-time" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] }, - "updated_at": { + "type": { "type": "string", - "format": "date-time" + "examples": [ + "User" + ] }, - "draft": { + "site_admin": { "type": "boolean" }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" ] }, - "body_html": { - "type": "string" + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com.", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description.", + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks" + ] + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + } + }, + "required": [ + "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" }, - "body_text": { - "type": "string" + "severity": "high", + "vulnerable_version_range": ">= 2.0.0, < 2.0.2", + "first_patched_version": { + "identifier": "2.0.2" + } + }, + { + "package": { + "ecosystem": "pip", + "name": "django" }, - "timeline_url": { - "type": "string", - "format": "uri" + "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" }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "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", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "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" - ] + "severity": "medium", + "vulnerable_version_range": ">= 2.9.0, < 2.9.18", + "first_patched_version": { + "identifier": "2.9.18" + } + }, + { + "package": { + "ecosystem": "pip", + "name": "ansible" }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "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", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 - ] - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "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" - ] + "severity": "medium", + "vulnerable_version_range": "< 2.8.19", + "first_patched_version": { + "identifier": "2.8.19" } }, - "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", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/issues/comments/1" - ] - }, - "body": { - "description": "Contents of the issue comment", - "type": "string", - "examples": [ - "What version of Safari were you using when you observed this bug?" - ] - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "OWNER" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "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", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 - ] - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] + { + "package": { + "ecosystem": "pip", + "name": "ansible" }, - "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" - ] + "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 }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "author_association", - "user", - "url", - "created_at", - "updated_at" - ] + "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 + } }, - "pages": { - "type": "array", - "items": { - "type": "object", - "properties": { - "page_name": { - "type": "string" - }, - "title": { - "type": "string" - }, - "summary": { - "type": [ - "string", - "null" - ] - }, - "action": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "html_url": { - "type": "string" - } - } + "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}" } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" } - }, - "required": [ - "id", - "type", - "actor", - "repo", - "payload", - "public", - "created_at" ] } - }, - "examples": { - "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" - }, - "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" - }, - "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" - }, - "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" + } + } + } + }, + "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "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" + } + } } } } @@ -102876,22 +99227,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "activity", - "subcategory": "events" + "category": "dependabot", + "subcategory": "alerts" } } }, - "/orgs/{org}/failed_invitations": { + "/orgs/{org}/dependabot/secrets": { "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 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-failed-invitations", + "operationId": "dependabot/list-org-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/members#list-failed-organization-invitations" + "url": "https://docs.github.com/rest/dependabot/secrets#list-organization-secrets" }, "parameters": [ { @@ -102928,286 +99279,90 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Organization Invitation", - "description": "Organization Invitation", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "role": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "failed_at": { - "type": [ - "string", - "null" - ] - }, - "failed_reason": { - "type": [ - "string", - "null" - ] - }, - "inviter": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { + "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.", "type": "string", "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 + "SECRET_TOKEN" ] }, - "node_id": { + "created_at": { "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "format": "date-time" }, - "avatar_url": { + "updated_at": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] + "format": "date-time" }, - "gravatar_id": { - "type": [ - "string", - "null" + "visibility": { + "description": "Visibility of a secret", + "enum": [ + "all", + "private", + "selected" ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "type": "string" }, - "received_events_url": { + "selected_repositories_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" + "https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories" ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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", - "examples": [ - "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" - ] - }, - "invitation_teams_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/organizations/16/invitations/1/teams\"" - ] - }, - "invitation_source": { - "type": "string", - "examples": [ - "\"member\"" + "name", + "created_at", + "updated_at", + "visibility" ] } - }, - "required": [ - "id", - "login", - "email", - "role", - "created_at", - "inviter", - "team_count", - "invitation_teams_url", - "node_id" - ] + } } }, "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", - "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 + "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" }, - "team_count": 2, - "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams", - "invitation_source": "member" - } - ] + { + "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" + } + ] + } } } } @@ -103220,53 +99375,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": "members" + "category": "dependabot", + "subcategory": "secrets" } } }, - "/orgs/{org}/hooks": { + "/orgs/{org}/dependabot/secrets/public-key": { "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": "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/list-webhooks", + "operationId": "dependabot/get-org-public-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/webhooks#list-organization-webhooks" + "url": "https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key" }, "parameters": [ { @@ -103277,24 +99406,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": { @@ -103303,570 +99414,35 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Org Hook", - "description": "Org Hook", - "type": "object", - "properties": { - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/hooks/1" - ] - }, - "ping_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/hooks/1/pings" - ] - }, - "deliveries_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/hooks/1/deliveries" - ] - }, - "name": { - "type": "string", - "examples": [ - "web" - ] - }, - "events": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "push", - "pull_request" - ] - }, - "active": { - "type": "boolean", - "examples": [ - true - ] - }, - "config": { - "type": "object", - "properties": { - "url": { - "type": "string", - "examples": [ - "\"http://example.com/2\"" - ] - }, - "insecure_ssl": { - "type": "string", - "examples": [ - "\"0\"" - ] - }, - "content_type": { - "type": "string", - "examples": [ - "\"form\"" - ] - }, - "secret": { - "type": "string", - "examples": [ - "\"********\"" - ] - } - } - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-09-06T20:39:23Z" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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 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-webhook", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/webhooks#create-an-organization-webhook" - }, - "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": "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.", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"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).", - "examples": [ - "\"********\"" - ] - }, - "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.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ] - }, - "username": { - "type": "string", - "examples": [ - "\"kdaigle\"" - ] - }, - "password": { - "type": "string", - "examples": [ - "\"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": { - "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", - "examples": [ - 1 - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/hooks/1" - ] - }, - "ping_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/hooks/1/pings" - ] - }, - "deliveries_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/hooks/1/deliveries" - ] - }, - "name": { - "type": "string", - "examples": [ - "web" - ] - }, - "events": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "push", - "pull_request" - ] - }, - "active": { - "type": "boolean", - "examples": [ - true - ] - }, - "config": { - "type": "object", - "properties": { - "url": { - "type": "string", - "examples": [ - "\"http://example.com/2\"" - ] - }, - "insecure_ssl": { - "type": "string", - "examples": [ - "\"0\"" - ] - }, - "content_type": { - "type": "string", - "examples": [ - "\"form\"" - ] - }, - "secret": { - "type": "string", - "examples": [ - "\"********\"" - ] - } - } - }, - "updated_at": { + "key_id": { + "description": "The identifier for the key.", "type": "string", - "format": "date-time", "examples": [ - "2011-09-06T20:39:23Z" + "1234567" ] }, - "created_at": { + "key": { + "description": "The Base64 encoded public key.", "type": "string", - "format": "date-time", "examples": [ - "2011-09-06T17:26:27Z" + "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" ] - }, - "type": { - "type": "string" } }, "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", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "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" } } } @@ -103877,22 +99453,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": [ { @@ -103905,12 +99481,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" } } ], @@ -103920,165 +99496,57 @@ "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", - "examples": [ - 1 - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/hooks/1" - ] - }, - "ping_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/hooks/1/pings" - ] - }, - "deliveries_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/hooks/1/deliveries" - ] - }, "name": { + "description": "The name of the secret.", "type": "string", "examples": [ - "web" - ] - }, - "events": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "push", - "pull_request" - ] - }, - "active": { - "type": "boolean", - "examples": [ - true + "SECRET_TOKEN" ] }, - "config": { - "type": "object", - "properties": { - "url": { - "type": "string", - "examples": [ - "\"http://example.com/2\"" - ] - }, - "insecure_ssl": { - "type": "string", - "examples": [ - "\"0\"" - ] - }, - "content_type": { - "type": "string", - "examples": [ - "\"form\"" - ] - }, - "secret": { - "type": "string", - "examples": [ - "\"********\"" - ] - } - } + "created_at": { + "type": "string", + "format": "date-time" }, "updated_at": { "type": "string", - "format": "date-time", - "examples": [ - "2011-09-06T20:39:23Z" - ] + "format": "date-time" }, - "created_at": { + "visibility": { + "description": "Visibility of a secret", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "selected_repositories_url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2011-09-06T17:26:27Z" + "https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories" ] - }, - "type": { - "type": "string" } }, "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" } } } @@ -104089,20 +99557,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": [ { @@ -104115,96 +99583,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.", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"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).", - "examples": [ - "\"********\"" - ] - }, - "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.**", - "examples": [ - "\"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", - "examples": [ - "\"web\"" - ] } - } + }, + "required": [ + "visibility" + ] }, "examples": { "default": { "value": { - "active": true, - "events": [ - "pull_request" + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "selected", + "selected_repository_ids": [ + "1296269", + "1296280" ] } } @@ -104213,268 +99646,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", - "examples": [ - 1 - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/hooks/1" - ] - }, - "ping_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/hooks/1/pings" - ] - }, - "deliveries_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/hooks/1/deliveries" - ] - }, - "name": { - "type": "string", - "examples": [ - "web" - ] - }, - "events": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "push", - "pull_request" - ] - }, - "active": { - "type": "boolean", - "examples": [ - true - ] - }, - "config": { - "type": "object", - "properties": { - "url": { - "type": "string", - "examples": [ - "\"http://example.com/2\"" - ] - }, - "insecure_ssl": { - "type": "string", - "examples": [ - "\"0\"" - ] - }, - "content_type": { - "type": "string", - "examples": [ - "\"form\"" - ] - }, - "secret": { - "type": "string", - "examples": [ - "\"********\"" - ] - } - } - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-09-06T20:39:23Z" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "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": [ { @@ -104487,165 +99698,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.", - "tags": [ - "orgs" - ], - "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.", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"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).", - "examples": [ - "\"********\"" - ] - }, - "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.**", - "examples": [ - "\"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.", + "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/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": [ { @@ -104658,160 +99743,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.", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"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).", - "examples": [ - "\"********\"" - ] - }, - "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.**", - "examples": [ - "\"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.", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"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).", - "examples": [ - "\"********\"" - ] - }, - "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.**", - "examples": [ - "\"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": { @@ -104819,12 +99752,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 } }, { @@ -104835,15 +99768,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": { @@ -104852,1007 +99776,949 @@ "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", - "examples": [ - 42 - ] - }, - "guid": { - "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", - "type": "string", - "examples": [ - "58474f00-b361-11eb-836d-0e4f3503ccbe" - ] - }, - "delivered_at": { - "description": "Time when the webhook delivery occurred.", - "type": "string", - "format": "date-time", - "examples": [ - "2021-05-12T20:33:44Z" - ] - }, - "redelivery": { - "description": "Whether the webhook delivery is a redelivery.", - "type": "boolean", - "examples": [ - false - ] - }, - "duration": { - "description": "Time spent delivering.", - "type": "number", - "examples": [ - 0.03 - ] - }, - "status": { - "description": "Describes the response returned after attempting the delivery.", - "type": "string", - "examples": [ - "failed to connect" - ] - }, - "status_code": { - "description": "Status code received when delivery was made.", - "type": "integer", - "examples": [ - 502 - ] - }, - "event": { - "description": "The event that triggered the delivery.", - "type": "string", - "examples": [ - "issues" - ] - }, - "action": { - "description": "The type of activity for the event that triggered the delivery.", - "type": [ - "string", - "null" - ], - "examples": [ - "opened" - ] - }, - "installation_id": { - "description": "The id of the GitHub App installation associated with this event.", - "type": [ - "integer", - "null" - ], - "format": "int64", - "examples": [ - 123 - ] - }, - "repository_id": { - "description": "The id of the repository associated with this event.", - "type": [ - "integer", - "null" - ], - "format": "int64", - "examples": [ - 123 - ] - }, - "throttled_at": { - "description": "Time when the webhook delivery was throttled.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2021-05-12T20:33:44Z" - ] - } - }, - "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", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "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": { - "type": "string" - }, - "field": { - "type": "string" + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] }, - "message": { - "type": "string" + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] }, - "code": { - "type": "string" + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] }, - "index": { - "type": "integer" + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] }, - "value": { - "oneOf": [ - { - "type": [ - "string", + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", "null" ] }, - { + "email": { "type": [ - "integer", + "string", "null" ] }, - { + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { "type": [ - "array", + "string", "null" ], - "items": { - "type": "string" - } + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] - } - } - } - } - } - } - } - } - } - }, - "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": "Webhook delivery", - "description": "Delivery made by a webhook.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the delivery.", - "type": "integer", - "examples": [ - 42 - ] - }, - "guid": { - "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", - "type": "string", - "examples": [ - "58474f00-b361-11eb-836d-0e4f3503ccbe" - ] - }, - "delivered_at": { - "description": "Time when the delivery was delivered.", - "type": "string", - "format": "date-time", - "examples": [ - "2021-05-12T20:33:44Z" - ] - }, - "redelivery": { - "description": "Whether the delivery is a redelivery.", - "type": "boolean", - "examples": [ - false - ] - }, - "duration": { - "description": "Time spent delivering.", - "type": "number", - "examples": [ - 0.03 - ] - }, - "status": { - "description": "Description of the status of the attempted delivery", - "type": "string", - "examples": [ - "failed to connect" - ] - }, - "status_code": { - "description": "Status code received when delivery was made.", - "type": "integer", - "examples": [ - 502 - ] - }, - "event": { - "description": "The event that triggered the delivery.", - "type": "string", - "examples": [ - "issues" - ] - }, - "action": { - "description": "The type of activity for the event that triggered the delivery.", - "type": [ - "string", - "null" - ], - "examples": [ - "opened" - ] - }, - "installation_id": { - "description": "The id of the GitHub App installation associated with this event.", - "type": [ - "integer", - "null" - ], - "examples": [ - 123 - ] - }, - "repository_id": { - "description": "The id of the repository associated with this event.", - "type": [ - "integer", - "null" - ], - "examples": [ - 123 - ] - }, - "throttled_at": { - "description": "Time when the webhook delivery was throttled.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2021-05-12T20:33:44Z" - ] - }, - "url": { - "description": "The URL target of the delivery.", - "type": "string", - "examples": [ - "https://www.example.com" - ] - }, - "request": { - "type": "object", - "properties": { - "headers": { - "description": "The request headers sent with the webhook delivery.", - "type": [ - "object", - "null" - ], - "additionalProperties": true - }, - "payload": { - "description": "The webhook payload.", - "type": [ - "object", - "null" - ], - "additionalProperties": true - } - }, - "required": [ - "headers", - "payload" - ] - }, - "response": { - "type": "object", - "properties": { - "headers": { - "description": "The response headers received when the delivery was made.", - "type": [ - "object", - "null" - ], - "additionalProperties": true - }, - "payload": { - "description": "The response payload received.", - "type": [ - "string", - "null" - ], - "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", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "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": { + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { "type": "string" }, - "field": { + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { "type": "string" }, - "message": { + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { "type": "string" }, - "code": { + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { "type": "string" }, - "index": { + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { "type": "integer" }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] + "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", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" }, - { - "type": [ - "integer", - "null" - ] + "maintain": { + "type": "boolean" }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" } + } + }, + "role_name": { + "type": "string", + "examples": [ + "admin" ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "webhooks" - } - } - }, - "/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/redeliver-webhook-delivery", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/webhooks#redeliver-a-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": { - "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", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "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": { + "temp_clone_token": { "type": "string" }, - "message": { - "type": "string" + "delete_branch_on_merge": { + "type": "boolean" }, - "code": { - "type": "string" + "subscribers_count": { + "type": "integer" }, - "index": { + "network_count": { "type": "integer" }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" ] }, - { - "type": [ - "integer", - "null" + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" ] }, - { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# 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": [ - "array", + "string", "null" ], - "items": { - "type": "string" - } + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "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" + ] } } } - } - } - } - } - }, - "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", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + }, + "examples": { + "default": { + "value": { + "total_count": 1, + "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" + } + ] } } } @@ -105863,22 +100729,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "webhooks" + "category": "dependabot", + "subcategory": "secrets" } - } - }, - "/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}": { - "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.", + }, + "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": "api-insights/get-route-stats-by-actor", + "operationId": "dependabot/set-selected-repos-for-org-secret", "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/dependabot/secrets#set-selected-repositories-for-an-organization-secret" }, "parameters": [ { @@ -105891,164 +100755,39 @@ } }, { - "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", + "name": "secret_name", + "description": "The name of the secret.", "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": { - "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", - "null" - ] - }, - "last_request_timestamp": { - "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/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" } } }, - "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" - } + "required": [ + "selected_repository_ids" + ] + }, + "examples": { + "default": { + "value": { + "selected_repository_ids": [ + 64780797 ] } } @@ -106056,24 +100795,30 @@ } } }, + "responses": { + "204": { + "description": "Response" + } + }, "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "api-insights" + "category": "dependabot", + "subcategory": "secrets" } } }, - "/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.", + "/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": "api-insights/get-subject-stats", + "operationId": "dependabot/add-selected-repo-to-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/api-insights#get-subject-stats" + "url": "https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret" }, "parameters": [ { @@ -106086,163 +100831,48 @@ } }, { - "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", + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", "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, + "name": "repository_id", + "in": "path", + "required": true, "schema": { - "type": "string" + "type": "integer" } } ], "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", - "null" - ] - }, - "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" - } - ] - } - } - } - } + "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": "orgs", - "subcategory": "api-insights" + "category": "dependabot", + "subcategory": "secrets" } - } - }, - "/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.", + }, + "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": "api-insights/get-summary-stats", + "operationId": "dependabot/remove-selected-repo-from-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/api-insights#get-summary-stats" + "url": "https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret" }, "parameters": [ { @@ -106255,76 +100885,50 @@ } }, { - "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", + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", "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, + "name": "repository_id", + "in": "path", + "required": true, "schema": { - "type": "string" + "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 - } - } - } - } - } + "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": "orgs", - "subcategory": "api-insights" + "category": "dependabot", + "subcategory": "secrets" } } }, - "/orgs/{org}/insights/api/summary-stats/users/{user_id}": { + "/orgs/{org}/docker/conflicts": { "get": { - "summary": "Get summary stats by user", - "description": "Get overall statistics of API requests within the organization for a user.", + "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-summary-stats-by-user", + "operationId": "packages/list-docker-migration-conflicting-packages-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user" + "url": "https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization" }, "parameters": [ { @@ -106335,33 +100939,6 @@ "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": { @@ -106370,562 +100947,1270 @@ "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", - "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", - "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": "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": { + "title": "Package", + "description": "A software package", "type": "object", "properties": { - "timestamp": { - "type": "string" - }, - "total_request_count": { + "id": { + "description": "Unique identifier of the package.", "type": "integer", - "format": "int64" + "examples": [ + 1 + ] }, - "rate_limited_request_count": { + "name": { + "description": "The name of the package.", + "type": "string", + "examples": [ + "super-linter" + ] + }, + "package_type": { + "type": "string", + "enum": [ + "npm", + "maven", + "rubygems", + "docker", + "nuget", + "container" + ], + "examples": [ + "docker" + ] + }, + "url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/packages/container/super-linter" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "https://github.com/orgs/github/packages/container/package/super-linter" + ] + }, + "version_count": { + "description": "The number of versions of the package.", "type": "integer", - "format": "int64" + "examples": [ + 1 + ] + }, + "visibility": { + "type": "string", + "enum": [ + "private", + "public" + ], + "examples": [ + "private" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "repository": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "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", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# 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", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "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" + ] + } + ] + }, + "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": [ { - "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 + "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" }, { - "timestamp": "2024-09-11T15:25:00Z", - "total_request_count": 55872, - "rate_limited_request_count": 23 + "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/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", + "403": { + "description": "Forbidden", "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" - } + "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": [ - { - "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", + "401": { + "description": "Requires authentication", "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" - } + "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": [ - { - "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": [ { @@ -106937,42 +102222,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).\"", @@ -106983,46 +102232,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 } } ], @@ -107032,2570 +102247,3763 @@ "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", - "null" - ], - "format": "int64" - }, - "oauth_application_id": { + "type": { "type": [ - "integer", + "string", "null" - ], - "format": "int64" + ] }, - "total_request_count": { - "type": "integer" + "actor": { + "title": "Actor", + "description": "Actor", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "display_login": { + "type": "string" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "login", + "gravatar_id", + "url", + "avatar_url" + ] }, - "rate_limited_request_count": { - "type": "integer" + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "name", + "url" + ] }, - "last_rate_limited_timestamp": { - "type": [ - "string", - "null" + "org": { + "title": "Actor", + "description": "Actor", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "display_login": { + "type": "string" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "login", + "gravatar_id", + "url", + "avatar_url" ] }, - "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", - "examples": [ - 1 - ] - }, - "account": { - "anyOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "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" - ] - } - ], - "type": [ - "null", - "object" - ] - }, - "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", - "examples": [ - "https://api.github.com/app/installations/1/access_tokens" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/installation/repositories" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/organizations/github/settings/installations/1" - ] - }, - "app_id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "client_id": { - "type": "string", - "examples": [ - "Iv1.ab1112223334445c" - ] - }, - "target_id": { - "description": "The ID of the user or organization this token is being scoped to.", - "type": "integer" - }, - "target_type": { - "type": "string", - "examples": [ - "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" - ] - } - }, - "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", - "null" - ], - "examples": [ - "config.yaml" - ] - }, - "has_multiple_single_files": { - "type": "boolean", - "examples": [ - true - ] - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "config.yml", - ".github/issue_TEMPLATE.md" - ] - }, - "app_slug": { - "type": "string", - "examples": [ - "github-actions" - ] - }, - "suspended_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "suspended_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "contact_email": { - "type": [ - "string", - "null" - ], - "examples": [ - "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" - ] - } - }, - "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", + "payload": { "type": "object", "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "examples": [ - 1 - ] - }, - "account": { - "anyOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "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" - ] - } - ], - "type": [ - "null", - "object" - ] - }, - "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", - "examples": [ - "https://api.github.com/app/installations/1/access_tokens" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/installation/repositories" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/organizations/github/settings/installations/1" - ] - }, - "app_id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "client_id": { - "type": "string", - "examples": [ - "Iv1.ab1112223334445c" - ] - }, - "target_id": { - "description": "The ID of the user or organization this token is being scoped to.", - "type": "integer" - }, - "target_type": { - "type": "string", - "examples": [ - "Organization" - ] + "action": { + "type": "string" }, - "permissions": { - "title": "App Permissions", + "issue": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "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" - ] + "id": { + "type": "integer", + "format": "int64" }, - "members": { - "type": "string", - "description": "The level of permission to grant the access token for organization teams and members.", - "enum": [ - "read", - "write" - ] + "node_id": { + "type": "string" }, - "organization_administration": { + "url": { + "description": "URL for the issue", "type": "string", - "description": "The level of permission to grant the access token to manage access to an organization.", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/1" ] }, - "organization_custom_roles": { + "repository_url": { "type": "string", - "description": "The level of permission to grant the access token for custom repository roles management.", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "organization_custom_org_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom organization roles management.", - "enum": [ - "read", - "write" - ] + "labels_url": { + "type": "string" }, - "organization_custom_properties": { + "comments_url": { "type": "string", - "description": "The level of permission to grant the access token for custom property management.", - "enum": [ - "read", - "write", - "admin" - ] + "format": "uri" }, - "organization_copilot_seat_management": { + "events_url": { "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" - ] + "format": "uri" }, - "organization_announcement_banners": { + "html_url": { "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": "uri" }, - "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" + "number": { + "description": "Number uniquely identifying the issue within its repository", + "type": "integer", + "examples": [ + 42 ] }, - "organization_hooks": { + "state": { + "description": "State of the issue; either 'open' or 'closed'", "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "enum": [ - "read", - "write" + "examples": [ + "open" ] }, - "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.", + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], "enum": [ - "read", - "write" + "completed", + "reopened", + "not_planned", + "duplicate", + null + ], + "examples": [ + "not_planned" ] }, - "organization_personal_access_token_requests": { + "title": { + "description": "Title of the issue", "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" + "examples": [ + "Widget creation fails in Safari on OS X 10.8" ] }, - "organization_plan": { - "type": "string", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "enum": [ - "read" + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ], + "examples": [ + "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?" ] }, - "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" + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } ] }, - "organization_packages": { - "type": "string", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "enum": [ - "read", - "write" + "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", + "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", + "null" + ] + }, + "color": { + "type": [ + "string", + "null" + ] + }, + "default": { + "type": "boolean" + } + } + } + ] + }, + "examples": [ + "bug", + "registration" ] }, - "organization_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization secrets.", - "enum": [ - "read", - "write" + "assignee": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } ] }, - "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" - ] + "assignees": { + "type": [ + "array", + "null" + ], + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } }, - "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" + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string", + "examples": [ + "v1.0" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] + } + }, + "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" + ] + } ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] + "locked": { + "type": "boolean" }, - "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" + "active_lock_reason": { + "type": [ + "string", + "null" ] }, - "followers": { - "type": "string", - "description": "The level of permission to grant the access token to manage the followers belonging to a user.", - "enum": [ - "read", - "write" - ] + "comments": { + "type": "integer" }, - "git_ssh_keys": { - "type": "string", - "description": "The level of permission to grant the access token to manage git SSH keys.", - "enum": [ - "read", - "write" + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" ] }, - "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" - ] + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - "interaction_limits": { + "created_at": { "type": "string", - "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", - "enum": [ - "read", - "write" - ] + "format": "date-time" }, - "profile": { + "updated_at": { "type": "string", - "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", - "enum": [ - "write" + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } ] }, - "starring": { + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { "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", - "null" - ], - "examples": [ - "config.yaml" - ] - }, - "has_multiple_single_files": { - "type": "boolean", - "examples": [ - true - ] - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "config.yml", - ".github/issue_TEMPLATE.md" - ] - }, - "app_slug": { - "type": "string", - "examples": [ - "github-actions" - ] - }, - "suspended_by": { - "anyOf": [ - { - "type": "null" + "format": "uri" }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], "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", "null" - ] + ], + "description": "The description of the issue type." }, - "email": { + "color": { "type": [ "string", "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null ] }, - "login": { + "created_at": { "type": "string", - "examples": [ - "octocat" - ] + "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", "type": "integer", "format": "int64", "examples": [ - 1 + 42 ] }, "node_id": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "avatar_url": { + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "https://github.com/octocat/Hello-World" ] }, - "gravatar_id": { + "description": { "type": [ "string", "null" ], "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "This your first repo!" ] }, + "fork": { + "type": "boolean" + }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "https://api.github.com/repos/octocat/Hello-World" ] }, - "html_url": { + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat" + "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, - "followers_url": { + "deployments_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, - "following_url": { + "downloads_url": { "type": "string", + "format": "uri", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, - "gists_url": { + "events_url": { "type": "string", + "format": "uri", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "http://api.github.com/repos/octocat/Hello-World/events" ] }, - "starred_url": { + "forks_url": { "type": "string", + "format": "uri", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "http://api.github.com/repos/octocat/Hello-World/forks" ] }, - "subscriptions_url": { + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "http://api.github.com/repos/octocat/Hello-World/languages" ] }, - "organizations_url": { + "merges_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "http://api.github.com/repos/octocat/Hello-World/merges" ] }, - "repos_url": { + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, - "events_url": { + "statuses_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, - "received_events_url": { + "subscribers_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, - "type": { + "subscription_url": { "type": "string", + "format": "uri", "examples": [ - "User" + "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, - "site_admin": { + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { "type": "boolean" }, - "starred_at": { + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", "examples": [ - "\"2020-07-09T00:17:55Z\"" + true ] }, - "user_view_type": { + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { "type": "string", "examples": [ - "public" + "\"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": [ - "avatar_url", + "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", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "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" ] - } - ] - }, - "suspended_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "contact_email": { - "type": [ - "string", - "null" - ], - "examples": [ - "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" - ] - } - }, - "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": { - "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.", - "enum": [ - "existing_users", - "contributors_only", - "collaborators_only" - ], - "examples": [ - "collaborators_only" - ] - }, - "origin": { - "type": "string", - "examples": [ - "repository" - ] - }, - "expires_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-08-17T04:18:39Z" - ] - } - }, - "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.", - "enum": [ - "existing_users", - "contributors_only", - "collaborators_only" - ], - "examples": [ - "collaborators_only" - ] - }, - "expiry": { - "type": "string", - "description": "The duration of the interaction restriction. Default: `one_day`.", - "enum": [ - "one_day", - "three_days", - "one_week", - "one_month", - "six_months" - ], - "examples": [ - "one_month" - ] - } - }, - "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.", - "enum": [ - "existing_users", - "contributors_only", - "collaborators_only" - ], - "examples": [ - "collaborators_only" - ] - }, - "origin": { - "type": "string", - "examples": [ - "repository" - ] - }, - "expires_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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" + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "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", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "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" + ] }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" + "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", + "type": "integer", + "format": "int64", + "examples": [ + 42 ] }, - { - "type": [ - "integer", - "null" + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/comments/1" ] }, - { - "type": [ - "array", - "null" + "body": { + "description": "Contents of the issue comment", + "type": "string", + "examples": [ + "What version of Safari were you using when you observed this bug?" + ] + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" ], - "items": { + "examples": [ + "OWNER" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "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", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "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", + "null" + ] + }, + "action": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "html_url": { "type": "string" } } - ] + } } } + }, + "public": { + "type": "boolean" + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" } - } + }, + "required": [ + "id", + "type", + "actor", + "repo", + "payload", + "public", + "created_at" + ] + } + }, + "examples": { + "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" + }, + "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" + }, + "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" + }, + "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" + } + ] } } } @@ -109605,56 +106013,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": [ { @@ -109683,38 +106057,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": { @@ -110049,17 +106391,251 @@ "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", + "examples": [ + 1 + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/hooks/1" + ] + }, + "ping_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/hooks/1/pings" + ] + }, + "deliveries_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/hooks/1/deliveries" + ] + }, + "name": { + "type": "string", + "examples": [ + "web" + ] + }, + "events": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "push", + "pull_request" + ] + }, + "active": { + "type": "boolean", + "examples": [ + true + ] + }, + "config": { + "type": "object", + "properties": { + "url": { + "type": "string", + "examples": [ + "\"http://example.com/2\"" + ] + }, + "insecure_ssl": { + "type": "string", + "examples": [ + "\"0\"" + ] + }, + "content_type": { + "type": "string", + "examples": [ + "\"form\"" + ] + }, + "secret": { + "type": "string", + "examples": [ + "\"********\"" + ] + } + } + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-09-06T20:39:23Z" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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": [ { @@ -110073,49 +106649,107 @@ } ], "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.", + "format": "uri", + "examples": [ + "https://example.com/webhook" + ] + }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"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).", + "examples": [ + "\"********\"" + ] + }, + "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.**", + "examples": [ + "\"0\"" + ] + }, + { + "type": "number" + } + ] + }, + "username": { + "type": "string", + "examples": [ + "\"kdaigle\"" + ] + }, + "password": { + "type": "string", + "examples": [ + "\"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" + } } } } @@ -110128,282 +106762,151 @@ "content": { "application/json": { "schema": { - "title": "Organization Invitation", - "description": "Organization Invitation", + "title": "Org Hook", + "description": "Org Hook", "type": "object", "properties": { "id": { "type": "integer", - "format": "int64" + "examples": [ + 1 + ] }, - "login": { - "type": [ - "string", - "null" + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/hooks/1" ] }, - "email": { - "type": [ - "string", - "null" + "ping_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/hooks/1/pings" ] }, - "role": { - "type": "string" + "deliveries_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/hooks/1/deliveries" + ] }, - "created_at": { - "type": "string" + "name": { + "type": "string", + "examples": [ + "web" + ] }, - "failed_at": { - "type": [ - "string", - "null" + "events": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "push", + "pull_request" ] }, - "failed_reason": { - "type": [ - "string", - "null" + "active": { + "type": "boolean", + "examples": [ + true ] }, - "inviter": { - "title": "Simple User", - "description": "A GitHub user.", + "config": { "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" + "url": { + "type": "string", + "examples": [ + "\"http://example.com/2\"" ] }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { + "insecure_ssl": { "type": "string", "examples": [ - "User" + "\"0\"" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { + "content_type": { "type": "string", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "\"form\"" ] }, - "user_view_type": { + "secret": { "type": "string", "examples": [ - "public" + "\"********\"" ] } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "team_count": { - "type": "integer" + } }, - "node_id": { + "updated_at": { "type": "string", + "format": "date-time", "examples": [ - "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" + "2011-09-06T20:39:23Z" ] }, - "invitation_teams_url": { + "created_at": { "type": "string", + "format": "date-time", "examples": [ - "\"https://api.github.com/organizations/16/invitations/1/teams\"" + "2011-09-06T17:26:27Z" ] }, - "invitation_source": { - "type": "string", - "examples": [ - "\"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": { @@ -110509,25 +107012,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": [ { @@ -110540,8 +107042,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": { @@ -110550,8 +107052,446 @@ } ], "responses": { - "204": { - "description": "Response" + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Org Hook", + "description": "Org Hook", + "type": "object", + "properties": { + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/hooks/1" + ] + }, + "ping_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/hooks/1/pings" + ] + }, + "deliveries_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/hooks/1/deliveries" + ] + }, + "name": { + "type": "string", + "examples": [ + "web" + ] + }, + "events": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "push", + "pull_request" + ] + }, + "active": { + "type": "boolean", + "examples": [ + true + ] + }, + "config": { + "type": "object", + "properties": { + "url": { + "type": "string", + "examples": [ + "\"http://example.com/2\"" + ] + }, + "insecure_ssl": { + "type": "string", + "examples": [ + "\"0\"" + ] + }, + "content_type": { + "type": "string", + "examples": [ + "\"form\"" + ] + }, + "secret": { + "type": "string", + "examples": [ + "\"********\"" + ] + } + } + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-09-06T20:39:23Z" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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.", + "format": "uri", + "examples": [ + "https://example.com/webhook" + ] + }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"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).", + "examples": [ + "\"********\"" + ] + }, + "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.**", + "examples": [ + "\"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", + "examples": [ + "\"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", + "examples": [ + 1 + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/hooks/1" + ] + }, + "ping_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/hooks/1/pings" + ] + }, + "deliveries_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/hooks/1/deliveries" + ] + }, + "name": { + "type": "string", + "examples": [ + "web" + ] + }, + "events": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "push", + "pull_request" + ] + }, + "active": { + "type": "boolean", + "examples": [ + true + ] + }, + "config": { + "type": "object", + "properties": { + "url": { + "type": "string", + "examples": [ + "\"http://example.com/2\"" + ] + }, + "insecure_ssl": { + "type": "string", + "examples": [ + "\"0\"" + ] + }, + "content_type": { + "type": "string", + "examples": [ + "\"form\"" + ] + }, + "secret": { + "type": "string", + "examples": [ + "\"********\"" + ] + } + } + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-09-06T20:39:23Z" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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.", @@ -110656,25 +107596,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": [ { @@ -110687,282 +107624,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", - "null" - ] - }, - "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", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] - } - ] - } - }, - "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", @@ -110995,21 +107668,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": [ { @@ -111020,6 +107693,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": { @@ -111028,120 +107710,55 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "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", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "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.", + "format": "uri", + "examples": [ + "https://example.com/webhook" + ] }, - "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`.", + "examples": [ + "\"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).", + "examples": [ + "\"********\"" + ] }, - "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.**", + "examples": [ + "\"0\"" + ] + }, + { + "type": "number" + } + ] + } + } + }, + "examples": { + "default": { + "value": { + "content_type": "json", + "insecure_ssl": "0", + "secret": "********", + "url": "https://example.com/webhook" } } } @@ -111153,19 +107770,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": [ { @@ -111176,61 +107793,70 @@ "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" + "url": { + "type": "string", + "description": "The URL to which the payloads will be delivered.", + "format": "uri", + "examples": [ + "https://example.com/webhook" + ] }, - "is_enabled": { - "description": "Whether or not the issue type is enabled at the organization level.", - "type": "boolean" + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"json\"" + ] }, - "description": { - "description": "Description of the issue type.", - "type": [ - "string", - "null" + "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).", + "examples": [ + "\"********\"" ] }, - "color": { - "description": "Color for the issue type.", - "type": [ - "string", - "null" - ], - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null + "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.**", + "examples": [ + "\"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": "********" } } } @@ -111243,89 +107869,288 @@ "content": { "application/json": { "schema": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", + "type": "object", "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": { + "url": { "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null + "description": "The URL to which the payloads will be delivered.", + "format": "uri", + "examples": [ + "https://example.com/webhook" ] }, - "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`.", + "examples": [ + "\"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).", + "examples": [ + "\"********\"" + ] }, - "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.**", + "examples": [ + "\"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" + "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.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "404": { - "description": "Resource not found", + { + "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" + } + } + ], + "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", + "examples": [ + 42 + ] + }, + "guid": { + "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", + "type": "string", + "examples": [ + "58474f00-b361-11eb-836d-0e4f3503ccbe" + ] + }, + "delivered_at": { + "description": "Time when the webhook delivery occurred.", + "type": "string", + "format": "date-time", + "examples": [ + "2021-05-12T20:33:44Z" + ] + }, + "redelivery": { + "description": "Whether the webhook delivery is a redelivery.", + "type": "boolean", + "examples": [ + false + ] + }, + "duration": { + "description": "Time spent delivering.", + "type": "number", + "examples": [ + 0.03 + ] + }, + "status": { + "description": "Describes the response returned after attempting the delivery.", + "type": "string", + "examples": [ + "failed to connect" + ] + }, + "status_code": { + "description": "Status code received when delivery was made.", + "type": "integer", + "examples": [ + 502 + ] + }, + "event": { + "description": "The event that triggered the delivery.", + "type": "string", + "examples": [ + "issues" + ] + }, + "action": { + "description": "The type of activity for the event that triggered the delivery.", + "type": [ + "string", + "null" + ], + "examples": [ + "opened" + ] + }, + "installation_id": { + "description": "The id of the GitHub App installation associated with this event.", + "type": [ + "integer", + "null" + ], + "format": "int64", + "examples": [ + 123 + ] + }, + "repository_id": { + "description": "The id of the repository associated with this event.", + "type": [ + "integer", + "null" + ], + "format": "int64", + "examples": [ + 123 + ] + }, + "throttled_at": { + "description": "Time when the webhook delivery was throttled.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2021-05-12T20:33:44Z" + ] + } + }, + "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": { @@ -111347,6 +108172,48 @@ } } } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } } } }, @@ -111355,8 +108222,8 @@ "content": { "application/json": { "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", + "title": "Validation Error", + "description": "Validation Error", "type": "object", "required": [ "message", @@ -111372,7 +108239,52 @@ "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } } } } @@ -111385,21 +108297,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/{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/update-issue-type", + "operationId": "orgs/get-webhook-delivery", "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#get-a-webhook-delivery-for-an-organization-webhook" }, "parameters": [ { @@ -111412,163 +108324,258 @@ } }, { - "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" } - } - ], - "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", - "null" - ] - }, - "color": { - "description": "Color for the issue type.", - "type": [ - "string", - "null" - ], - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - } - }, - "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" - } - } - } + }, + { + "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.", - "type": [ - "object", - "null" - ], + "title": "Webhook delivery", + "description": "Delivery made by a webhook.", + "type": "object", "properties": { "id": { + "description": "Unique identifier of the delivery.", "type": "integer", - "description": "The unique identifier of the issue type." + "examples": [ + 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." + "examples": [ + "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", + "examples": [ + "2021-05-12T20:33:44Z" + ] }, - "description": { + "redelivery": { + "description": "Whether the delivery is a redelivery.", + "type": "boolean", + "examples": [ + false + ] + }, + "duration": { + "description": "Time spent delivering.", + "type": "number", + "examples": [ + 0.03 + ] + }, + "status": { + "description": "Description of the status of the attempted delivery", + "type": "string", + "examples": [ + "failed to connect" + ] + }, + "status_code": { + "description": "Status code received when delivery was made.", + "type": "integer", + "examples": [ + 502 + ] + }, + "event": { + "description": "The event that triggered the delivery.", + "type": "string", + "examples": [ + "issues" + ] + }, + "action": { + "description": "The type of activity for the event that triggered the delivery.", "type": [ "string", "null" ], - "description": "The description of the issue type." + "examples": [ + "opened" + ] }, - "color": { + "installation_id": { + "description": "The id of the GitHub App installation associated with this event.", + "type": [ + "integer", + "null" + ], + "examples": [ + 123 + ] + }, + "repository_id": { + "description": "The id of the repository associated with this event.", + "type": [ + "integer", + "null" + ], + "examples": [ + 123 + ] + }, + "throttled_at": { + "description": "Time when the webhook delivery was throttled.", "type": [ "string", "null" ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null + "format": "date-time", + "examples": [ + "2021-05-12T20:33:44Z" ] }, - "created_at": { + "url": { + "description": "The URL target of the delivery.", "type": "string", - "description": "The time the issue type created.", - "format": "date-time" + "examples": [ + "https://www.example.com" + ] }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" + "request": { + "type": "object", + "properties": { + "headers": { + "description": "The request headers sent with the webhook delivery.", + "type": [ + "object", + "null" + ], + "additionalProperties": true + }, + "payload": { + "description": "The webhook payload.", + "type": [ + "object", + "null" + ], + "additionalProperties": true + } + }, + "required": [ + "headers", + "payload" + ] }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." + "response": { + "type": "object", + "properties": { + "headers": { + "description": "The response headers received when the delivery was made.", + "type": [ + "object", + "null" + ], + "additionalProperties": true + }, + "payload": { + "description": "The response payload received.", + "type": [ + "string", + "null" + ], + "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": { @@ -111590,6 +108597,48 @@ } } } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } } } }, @@ -111598,8 +108647,8 @@ "content": { "application/json": { "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", + "title": "Validation Error", + "description": "Validation Error", "type": "object", "required": [ "message", @@ -111615,11 +108664,56 @@ "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } } } } @@ -111628,19 +108722,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": [ { @@ -111653,8 +108749,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": { @@ -111663,16 +108767,96 @@ } ], "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "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", @@ -111688,13 +108872,103 @@ "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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", @@ -111727,21 +109001,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": [ { @@ -111754,69 +109028,234 @@ } }, { - "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", + "null" + ] + }, + "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 } }, { @@ -111834,31 +109273,429 @@ } }, { - "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", + "null" + ] + }, + "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" } } ], @@ -111868,499 +109705,588 @@ "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", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/issues/1" - ] + { + "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", + { + "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", - "examples": [ - 42 - ] + "format": "int64" }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] + "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 }, - "state_reason": { - "description": "The reason for the current state", + { + "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" + }, + "actor_name": { + "type": "string" + }, + "actor_id": { + "type": "integer", + "format": "int64" + }, + "integration_id": { "type": [ - "string", + "integer", "null" ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ], - "examples": [ - "not_planned" - ] - }, - "title": { - "description": "Title of the issue", - "type": "string", - "examples": [ - "Widget creation fails in Safari on OS X 10.8" - ] + "format": "int64" }, - "body": { - "description": "Contents of the issue", + "oauth_application_id": { "type": [ - "string", + "integer", "null" ], - "examples": [ - "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?" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] + "format": "int64" }, - "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", - "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", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - }, - "examples": [ - "bug", - "registration" - ] + "total_request_count": { + "type": "integer" }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] + "rate_limited_request_count": { + "type": "integer" }, - "assignees": { + "last_rate_limited_timestamp": { "type": [ - "array", + "string", "null" - ], - "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", + "examples": [ + 1 + ] + }, + "account": { + "anyOf": [ + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -112527,2124 +110453,2653 @@ "type", "url" ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/milestones/v1.0" - ] - }, - "labels_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDk6TWlsZXN0b25lMTAwMjYwNA==" - ] - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "examples": [ - 42 - ] - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open", - "examples": [ - "open" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string", - "examples": [ - "v1.0" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "Tracking milestone for version 1.0" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 4 - ] - }, - "closed_issues": { - "type": "integer", - "examples": [ - 8 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2013-02-12T13:22:01Z" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2012-10-09T23:39:01Z" - ] - } - }, - "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" - ] - } - ] - }, - "locked": { - "type": "boolean" - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ], + "type": [ + "null", + "object" + ] + }, + "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", + "examples": [ + "https://api.github.com/app/installations/1/access_tokens" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/installation/repositories" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/organizations/github/settings/installations/1" + ] + }, + "app_id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, + "target_id": { + "description": "The ID of the user or organization this token is being scoped to.", + "type": "integer" + }, + "target_type": { + "type": "string", + "examples": [ + "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" + ] }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] + "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" + ] + } }, - "body_html": { + "example": { + "contents": "read", + "issues": "read", + "deployments": "write", + "single_file": "read" + } + }, + "events": { + "type": "array", + "items": { "type": "string" - }, - "body_text": { + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "single_file_name": { + "type": [ + "string", + "null" + ], + "examples": [ + "config.yaml" + ] + }, + "has_multiple_single_files": { + "type": "boolean", + "examples": [ + true + ] + }, + "single_file_paths": { + "type": "array", + "items": { "type": "string" }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "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", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "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." - } + "examples": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ] + }, + "app_slug": { + "type": "string", + "examples": [ + "github-actions" + ] + }, + "suspended_by": { + "anyOf": [ + { + "type": "null" }, - "required": [ - "id", - "node_id", - "name", - "description" - ] + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "contact_email": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" + ] + } + }, + "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": { - "title": "Repository", - "description": "A repository on GitHub.", + "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": { "id": { - "description": "Unique identifier of the repository", + "description": "The ID of the installation.", "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", "examples": [ - "octocat/Hello-World" + 1 ] }, - "license": { + "account": { "anyOf": [ { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "key": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { "type": "string", "examples": [ - "mit" + "octocat" ] }, - "name": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { "type": "string", "examples": [ - "MIT License" + "MDQ6VXNlcjE=" ] }, - "url": { + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { "type": [ "string", "null" ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", "format": "uri", "examples": [ - "https://api.github.com/licenses/mit" + "https://api.github.com/users/octocat" ] }, - "spdx_id": { + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", "type": [ "string", "null" ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", "examples": [ - "MIT" + 42 ] }, "node_id": { "type": "string", "examples": [ - "MDc6TGljZW5zZW1pdA==" + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "html_url": { + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { "type": "string", "format": "uri" } }, "required": [ - "key", + "id", + "node_id", "name", - "url", - "spdx_id", - "node_id" + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" ] } + ], + "type": [ + "null", + "object" ] }, - "forks": { + "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", + "examples": [ + "https://api.github.com/app/installations/1/access_tokens" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/installation/repositories" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/organizations/github/settings/installations/1" + ] + }, + "app_id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, + "target_id": { + "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" }, + "target_type": { + "type": "string", + "examples": [ + "Organization" + ] + }, "permissions": { + "title": "App Permissions", "type": "object", + "description": "The permissions granted to the user access token.", "properties": { - "admin": { - "type": "boolean" + "actions": { + "type": "string", + "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", + "enum": [ + "read", + "write" + ] }, - "pull": { - "type": "boolean" + "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" + ] }, - "triage": { - "type": "boolean" + "checks": { + "type": "string", + "description": "The level of permission to grant the access token for checks on code.", + "enum": [ + "read", + "write" + ] }, - "push": { - "type": "boolean" + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" + "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" ] }, - "email": { - "type": [ - "string", - "null" + "dependabot_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" ] }, - "login": { + "deployments": { "type": "string", - "examples": [ - "octocat" + "description": "The level of permission to grant the access token for deployments and deployment statuses.", + "enum": [ + "read", + "write" ] }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 + "environments": { + "type": "string", + "description": "The level of permission to grant the access token for managing repository environments.", + "enum": [ + "read", + "write" ] }, - "node_id": { + "issues": { "type": "string", - "examples": [ - "MDQ6VXNlcjE=" + "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", + "enum": [ + "read", + "write" ] }, - "avatar_url": { + "metadata": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", + "enum": [ + "read", + "write" ] }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "packages": { + "type": "string", + "description": "The level of permission to grant the access token for packages published to GitHub Packages.", + "enum": [ + "read", + "write" ] }, - "url": { + "pages": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" + "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" ] }, - "html_url": { + "pull_requests": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" + "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", + "enum": [ + "read", + "write" ] }, - "followers_url": { + "repository_custom_properties": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" + "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" ] }, - "following_url": { + "repository_hooks": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", + "enum": [ + "read", + "write" ] }, - "gists_url": { + "repository_projects": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", + "enum": [ + "read", + "write", + "admin" ] }, - "starred_url": { + "secret_scanning_alerts": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", + "enum": [ + "read", + "write" ] }, - "subscriptions_url": { + "secrets": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "description": "The level of permission to grant the access token to manage repository secrets.", + "enum": [ + "read", + "write" ] }, - "organizations_url": { + "security_events": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" + "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", + "enum": [ + "read", + "write" ] }, - "repos_url": { + "single_file": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" + "description": "The level of permission to grant the access token to manage just a single file.", + "enum": [ + "read", + "write" ] }, - "events_url": { + "statuses": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "description": "The level of permission to grant the access token for commit statuses.", + "enum": [ + "read", + "write" ] }, - "received_events_url": { + "vulnerability_alerts": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" + "description": "The level of permission to grant the access token to manage Dependabot alerts.", + "enum": [ + "read", + "write" ] }, - "type": { + "workflows": { "type": "string", - "examples": [ - "User" + "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", + "enum": [ + "write" ] }, - "site_admin": { - "type": "boolean" + "members": { + "type": "string", + "description": "The level of permission to grant the access token for organization teams and members.", + "enum": [ + "read", + "write" + ] }, - "starred_at": { + "organization_administration": { "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" + "description": "The level of permission to grant the access token to manage access to an organization.", + "enum": [ + "read", + "write" ] }, - "user_view_type": { + "organization_custom_roles": { "type": "string", - "examples": [ - "public" + "description": "The level of permission to grant the access token for custom repository roles management.", + "enum": [ + "read", + "write" ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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" + }, + "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" + } }, - "html_url": { + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "created_at": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] + "format": "date-time" }, - "description": { + "updated_at": { + "type": "string", + "format": "date-time" + }, + "single_file_name": { "type": [ "string", "null" ], "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + "config.yaml" ] }, - "branches_url": { - "type": "string", + "has_multiple_single_files": { + "type": "boolean", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + true ] }, - "collaborators_url": { - "type": "string", + "single_file_paths": { + "type": "array", + "items": { + "type": "string" + }, "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + "config.yml", + ".github/issue_TEMPLATE.md" ] }, - "comments_url": { + "app_slug": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + "github-actions" ] }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "suspended_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } ] }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - "contents_url": { - "type": "string", + "contact_email": { + "type": [ + "string", + "null" + ], "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" ] + } + }, + "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": { + "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 }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] + "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" }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] + "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.", + "enum": [ + "existing_users", + "contributors_only", + "collaborators_only" + ], + "examples": [ + "collaborators_only" + ] + }, + "origin": { + "type": "string", + "examples": [ + "repository" + ] + }, + "expires_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-08-17T04:18:39Z" + ] + } + }, + "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.", + "enum": [ + "existing_users", + "contributors_only", + "collaborators_only" + ], + "examples": [ + "collaborators_only" + ] + }, + "expiry": { + "type": "string", + "description": "The duration of the interaction restriction. Default: `one_day`.", + "enum": [ + "one_day", + "three_days", + "one_week", + "one_month", + "six_months" + ], + "examples": [ + "one_month" + ] + } + }, + "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.", + "enum": [ + "existing_users", + "contributors_only", + "collaborators_only" + ], + "examples": [ + "collaborators_only" + ] + }, + "origin": { + "type": "string", + "examples": [ + "repository" + ] + }, + "expires_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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" }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] + "field": { + "type": "string" }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] + "message": { + "type": "string" }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] + "code": { + "type": "string" }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] + "index": { + "type": "integer" }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + } + } + } + } + } + } + } + } + } + }, + "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", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "role": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "failed_at": { + "type": [ + "string", + "null" + ] + }, + "failed_reason": { + "type": [ + "string", + "null" + ] + }, + "inviter": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" ] }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" + "email": { + "type": [ + "string", + "null" ] }, - "issue_comment_url": { + "login": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + "octocat" ] }, - "issue_events_url": { - "type": "string", + "id": { + "type": "integer", + "format": "int64", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + 1 ] }, - "issues_url": { + "node_id": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + "MDQ6VXNlcjE=" ] }, - "keys_url": { + "avatar_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + "https://github.com/images/error/octocat_happy.gif" ] }, - "labels_url": { - "type": "string", + "gravatar_id": { + "type": [ + "string", + "null" + ], "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + "41d064eb2195891e12d0413f63227ea7" ] }, - "languages_url": { + "url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" + "https://api.github.com/users/octocat" ] }, - "merges_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" + "https://github.com/octocat" ] }, - "stargazers_url": { + "followers_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" + "https://api.github.com/users/octocat/followers" ] }, - "statuses_url": { + "following_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "subscribers_url": { + "gists_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "subscription_url": { + "starred_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "tags_url": { + "subscriptions_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" + "https://api.github.com/users/octocat/subscriptions" ] }, - "teams_url": { + "organizations_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + "https://api.github.com/users/octocat/orgs" ] }, - "clone_url": { + "repos_url": { "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], "format": "uri", "examples": [ - "git:git.example.com/octocat/Hello-World" + "https://api.github.com/users/octocat/repos" ] }, - "hooks_url": { + "events_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "svn_url": { + "received_events_url": { "type": "string", "format": "uri", "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 + "https://api.github.com/users/octocat/received_events" ] }, - "default_branch": { - "description": "The default branch of the repository.", + "type": { "type": "string", "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true + "User" ] }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, + "site_admin": { "type": "boolean" }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "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": { + "starred_at": { "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", "examples": [ - true + "\"2020-07-09T00:17:55Z\"" ] }, - "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": { + "user_view_type": { "type": "string", "examples": [ - "\"2020-07-09T00:17:42Z\"" + "public" ] - }, - "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", + "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", - "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" + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "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", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 - ] - } - }, - "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", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], "examples": [ - "OWNER" + "\"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", + "examples": [ + "\"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", + "examples": [ + "\"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" ] } }, @@ -114653,263 +113108,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" } ] } @@ -114954,23 +113182,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": [ { @@ -114981,267 +113207,340 @@ "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": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "title": "Organization Invitation", + "description": "Organization Invitation", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "role": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "failed_at": { + "type": [ + "string", + "null" + ] + }, + "failed_reason": { + "type": [ + "string", + "null" + ] + }, + "inviter": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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", + "examples": [ + "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" + ] + }, + "invitation_teams_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/organizations/16/invitations/1/teams\"" + ] + }, + "invitation_source": { + "type": "string", + "examples": [ + "\"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" + } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } } }, "422": { @@ -115318,9 +113617,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", @@ -115328,17 +113654,17 @@ } } }, - "/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.", + "/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/check-membership-for-user", + "operationId": "orgs/cancel-invitation", "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#cancel-an-organization-invitation" }, "parameters": [ { @@ -115351,78 +113677,96 @@ } }, { - "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" } } ], "responses": { "204": { - "description": "Response if requester is an organization member and user is a member" + "description": "Response" }, - "302": { - "description": "Response if requester is not an organization member", - "headers": { - "Location": { - "example": "https://api.github.com/orgs/github/public_members/pezra", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { "schema": { - "type": "string" + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } } } } }, "404": { - "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", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -115449,6 +113793,7 @@ } }, "x-github": { + "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", @@ -115456,19 +113801,37 @@ } } }, - "/orgs/{org}/members/{username}/codespaces": { + "/orgs/{org}/invitations/{invitation_id}/teams": { "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.", + "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": [ - "codespaces" + "orgs" ], - "operationId": "codespaces/get-codespaces-for-user-in-org", + "operationId": "orgs/list-invitation-teams", "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/members#list-organization-invitation-teams" }, "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" + } + }, { "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).\"", @@ -115486,24 +113849,6 @@ "type": "integer", "default": 1 } - }, - { - "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": { @@ -115512,82 +113857,97 @@ "content": { "application/json": { "schema": { - "type": "object", - "required": [ - "total_count", - "codespaces" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "codespaces": { - "type": "array", - "items": { + "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", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { "type": "object", - "title": "Codespace", - "description": "A codespace.", "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] + "pull": { + "type": "boolean" }, - "name": { - "description": "Automatically generated name of this codespace.", - "type": "string", - "examples": [ - "monalisa-octocat-hello-world-g4wpq6h95q" - ] + "triage": { + "type": "boolean" }, - "display_name": { - "description": "Display name for this codespace.", - "type": [ - "string", - "null" - ], - "examples": [ - "bookish space pancake" - ] + "push": { + "type": "boolean" }, - "environment_id": { - "description": "UUID identifying this codespace's environment.", - "type": [ - "string", - "null" - ], - "examples": [ - "26a7c758-7299-4a73-b978-5a92a7ae98a0" - ] + "maintain": { + "type": "boolean" }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { + "description": "Unique identifier of the team", "type": "integer", - "format": "int64", "examples": [ 1 ] @@ -115595,1959 +113955,154 @@ "node_id": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "MDQ6VGVhbTE=" ] }, "url": { + "description": "URL for the team", "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" + "https://api.github.com/organizations/1/team/1" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { + "members_url": { "type": "string", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "https://api.github.com/organizations/1/team/1/members{/member}" ] }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "billable_owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { + "description": "Name of the team", "type": "string", - "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "Justice League" ] }, - "gravatar_id": { + "description": { + "description": "Description of the team", "type": [ "string", "null" ], "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "A great team." ] }, - "starred_url": { + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "admin" ] }, - "subscriptions_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "closed" ] }, - "organizations_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "notifications_enabled" ] }, - "repos_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "https://github.com/orgs/rails/teams/core" ] }, - "received_events_url": { + "repositories_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" + "https://api.github.com/organizations/1/team/1/repos" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { + "slug": { "type": "string", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "justice-league" ] }, - "user_view_type": { + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ - "public" + "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "examples": [ - "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", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# 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", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "type": "object", - "title": "Codespace machine", - "description": "A description of the machine powering a codespace.", - "properties": { - "name": { - "type": "string", - "description": "The name of the machine.", - "examples": [ - "standardLinux" - ] - }, - "display_name": { - "type": "string", - "description": "The display name of the machine includes cores, memory, and storage.", - "examples": [ - "4 cores, 16 GB RAM, 64 GB storage" - ] - }, - "operating_system": { - "type": "string", - "description": "The operating system of the machine.", - "examples": [ - "linux" - ] - }, - "storage_in_bytes": { - "type": "integer", - "description": "How much storage is available to the codespace.", - "examples": [ - 68719476736 - ] - }, - "memory_in_bytes": { - "type": "integer", - "description": "How much memory is available to the codespace.", - "examples": [ - 17179869184 - ] - }, - "cpus": { - "type": "integer", - "description": "How many cores are available to the codespace.", - "examples": [ - 4 - ] - }, - "prebuild_availability": { - "type": [ - "string", - "null" - ], - "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.", - "enum": [ - "none", - "ready", - "in_progress", - null - ], - "examples": [ - "ready" - ] - } - }, - "required": [ - "name", - "display_name", - "operating_system", - "storage_in_bytes", - "memory_in_bytes", - "cpus", - "prebuild_availability" - ] - } - ] - }, - "devcontainer_path": { - "description": "Path to devcontainer.json from repo root used to create Codespace.", - "type": [ - "string", - "null" - ], - "examples": [ - ".devcontainer/example/devcontainer.json" - ] - }, - "prebuild": { - "description": "Whether the codespace was created from a prebuild.", - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "last_used_at": { - "description": "Last known time this codespace was started.", - "type": "string", - "format": "date-time", - "examples": [ - "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" - ], - "type": "string", - "examples": [ - "Available" - ] - }, - "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", - "examples": [ - 0 - ] - }, - "behind": { - "description": "The number of commits the local repository is behind the remote.", - "type": "integer", - "examples": [ - 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", - "examples": [ - "main" - ] - } - } - }, - "location": { - "description": "The initally assigned location of a new codespace.", - "enum": [ - "EastUs", - "SouthEastAsia", - "WestEurope", - "WestUs2" - ], - "type": "string", - "examples": [ - "WestUs2" - ] - }, - "idle_timeout_minutes": { - "description": "The number of minutes of inactivity after which this codespace will be automatically stopped.", - "type": [ - "integer", - "null" - ], - "examples": [ - 60 - ] - }, - "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", - "null" - ], - "format": "uri" - }, - "pulls_url": { - "description": "API URL for the Pull Request associated with this codespace, if any.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "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", - "null" - ], - "items": { - "type": "string" - } - } - } - }, - "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", - "null" - ] - }, - "pending_operation_disabled_reason": { - "description": "Text to show user when codespace is disabled by a pending operation", - "type": [ - "string", - "null" - ] - }, - "idle_timeout_notice": { - "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy", - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ], - "examples": [ - 60 - ] - }, - "retention_expires_at": { - "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T20:01:12Z" - ] - }, - "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", - "null" - ], - "examples": [ - "you've used 100% of your spending limit for Codespaces" + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" ] } - }, - "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" ] } - } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] } }, "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": [] - } - ] - } + "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" + } + } } }, - "304": { - "description": "Not modified" - }, - "500": { - "description": "Internal Error", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -117571,9 +114126,141 @@ } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "members" + } + } + }, + "/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/list-issue-types", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/issue-types#list-issue-types-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": "array", + "items": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], + "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", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "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" + } + ] + } + } + } + } }, - "401": { - "description": "Requires authentication", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -117597,9 +114284,185 @@ } } } + } + }, + "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": "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 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", + "null" + ] + }, + "color": { + "description": "Color for the issue type.", + "type": [ + "string", + "null" + ], + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + } + }, + "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", + "null" + ], + "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", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "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": { @@ -117624,14 +114487,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" @@ -117639,11 +114506,11 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "errors": { + "type": "array", + "items": { + "type": "string" + } } } } @@ -117653,23 +114520,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organizations" + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "issue-types" } } }, - "/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}/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/delete-from-organization", + "operationId": "orgs/update-issue-type", "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/issue-types#update-issue-type-for-an-organization" }, "parameters": [ { @@ -117682,45 +114549,163 @@ } }, { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "codespace_name", + "name": "issue_type_id", + "description": "The unique identifier of the issue type.", "in": "path", "required": true, - "description": "The name of the codespace.", "schema": { - "type": "string" + "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", + "null" + ] + }, + "color": { + "description": "Color for the issue type.", + "type": [ + "string", + "null" + ], + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + } + }, + "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": { - "202": { - "description": "Accepted", + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "type": "object" + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], + "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", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "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": null + "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" + } } } } } }, - "304": { - "description": "Not modified" - }, - "500": { - "description": "Internal Error", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -117745,14 +114730,18 @@ } } }, - "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 Simple", + "description": "Validation Error Simple", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -117760,25 +114749,72 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "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.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "403": { - "description": "Forbidden", + { + "name": "issue_type_id", + "description": "The unique identifier of the issue type.", + "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": "Basic Error", - "description": "Basic Error", + "title": "Validation Error Simple", + "description": "Validation Error Simple", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -117786,11 +114822,11 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "errors": { + "type": "array", + "items": { + "type": "string" + } } } } @@ -117826,23 +114862,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organizations" + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "issue-types" } } }, - "/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}/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": [ - "codespaces" + "issues" ], - "operationId": "codespaces/stop-in-organization", + "operationId": "issues/list-for-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/issues/issues#list-organization-issues-assigned-to-the-authenticated-user" }, "parameters": [ { @@ -117855,22 +114891,112 @@ } }, { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, + "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": "codespace_name", - "in": "path", - "required": true, - "description": "The name of the codespace.", + "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": { @@ -117879,411 +115005,499 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "Codespace", - "description": "A codespace.", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "name": { - "description": "Automatically generated name of this codespace.", - "type": "string", - "examples": [ - "monalisa-octocat-hello-world-g4wpq6h95q" - ] - }, - "display_name": { - "description": "Display name for this codespace.", - "type": [ - "string", - "null" - ], - "examples": [ - "bookish space pancake" - ] - }, - "environment_id": { - "description": "UUID identifying this codespace's environment.", - "type": [ - "string", - "null" - ], - "examples": [ - "26a7c758-7299-4a73-b978-5a92a7ae98a0" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + "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" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + "node_id": { + "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" - ] - }, - "repository": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/1" + ] + }, + "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", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate", + null + ], + "examples": [ + "not_planned" + ] + }, + "title": { + "description": "Title of the issue", + "type": "string", + "examples": [ + "Widget creation fails in Safari on OS X 10.8" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ], + "examples": [ + "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?" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "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", + "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", + "null" + ] + }, + "color": { + "type": [ + "string", + "null" + ] + }, + "default": { + "type": "boolean" + } + } + } ] }, - "owner": { + "examples": [ + "bug", + "registration" + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "assignees": { + "type": [ + "array", + "null" + ], + "items": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -118450,1062 +115664,2168 @@ "type", "url" ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" + } + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string", + "examples": [ + "v1.0" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] + } }, - "pull": { - "type": "boolean" - } + "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" + ] } - }, - "role_name": { - "type": "string", - "examples": [ - "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", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# 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", - "null" - ], - "format": "uri" - } + ] + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" } }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "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" - ] - } + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] } - }, - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "type": "object", - "title": "Codespace machine", - "description": "A description of the machine powering a codespace.", - "properties": { - "name": { - "type": "string", - "description": "The name of the machine.", - "examples": [ - "standardLinux" - ] - }, - "display_name": { - "type": "string", - "description": "The display name of the machine includes cores, memory, and storage.", - "examples": [ - "4 cores, 16 GB RAM, 64 GB storage" - ] - }, - "operating_system": { - "type": "string", - "description": "The operating system of the machine.", - "examples": [ - "linux" - ] - }, - "storage_in_bytes": { - "type": "integer", - "description": "How much storage is available to the codespace.", - "examples": [ - 68719476736 - ] - }, - "memory_in_bytes": { - "type": "integer", - "description": "How much memory is available to the codespace.", - "examples": [ - 17179869184 - ] - }, - "cpus": { - "type": "integer", - "description": "How many cores are available to the codespace.", - "examples": [ - 4 - ] - }, - "prebuild_availability": { - "type": [ - "string", - "null" - ], - "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.", - "enum": [ - "none", - "ready", - "in_progress", - null - ], - "examples": [ - "ready" - ] - } + "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", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." }, - "required": [ - "name", - "display_name", - "operating_system", - "storage_in_bytes", - "memory_in_bytes", - "cpus", - "prebuild_availability" - ] - } - ] - }, - "devcontainer_path": { - "description": "Path to devcontainer.json from repo root used to create Codespace.", - "type": [ - "string", - "null" - ], - "examples": [ - ".devcontainer/example/devcontainer.json" - ] - }, - "prebuild": { - "description": "Whether the codespace was created from a prebuild.", - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "last_used_at": { - "description": "Last known time this codespace was started.", - "type": "string", - "format": "date-time", - "examples": [ - "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" - ], - "type": "string", - "examples": [ - "Available" - ] - }, - "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", - "examples": [ - 0 - ] + "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", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "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." + } }, - "behind": { - "description": "The number of commits the local repository is behind the remote.", - "type": "integer", - "examples": [ - 0 - ] + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } }, - "has_unpushed_changes": { - "description": "Whether the local repository has unpushed changes.", - "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" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "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", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "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" + } }, - "has_uncommitted_changes": { - "description": "Whether the local repository has uncommitted changes.", - "type": "boolean" + "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" + } }, - "ref": { - "description": "The current branch (or SHA if in detached HEAD state) of the local repository.", - "type": "string", - "examples": [ - "main" - ] - } - } - }, - "location": { - "description": "The initally assigned location of a new codespace.", - "enum": [ - "EastUs", - "SouthEastAsia", - "WestEurope", - "WestUs2" - ], - "type": "string", - "examples": [ - "WestUs2" - ] - }, - "idle_timeout_minutes": { - "description": "The number of minutes of inactivity after which this codespace will be automatically stopped.", - "type": [ - "integer", - "null" - ], - "examples": [ - 60 - ] - }, - "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", - "null" - ], - "format": "uri" - }, - "pulls_url": { - "description": "API URL for the Pull Request associated with this codespace, if any.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "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", - "null" - ], - "items": { - "type": "string" + "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" + ] } }, - "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", - "null" - ] - }, - "pending_operation_disabled_reason": { - "description": "Text to show user when codespace is disabled by a pending operation", - "type": [ - "string", - "null" - ] - }, - "idle_timeout_notice": { - "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy", - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ], - "examples": [ - 60 - ] - }, - "retention_expires_at": { - "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T20:01:12Z" - ] - }, - "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", - "null" - ], - "examples": [ - "you've used 100% of your spending limit for Codespaces" - ] - } - }, - "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" - ] + "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, - "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", + "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 - }, - "repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { + "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=", @@ -119525,1002 +117845,243 @@ "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, - "retention_period_minutes": 43200, - "retention_expires_at": null, - "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", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", - "recent_folders": [], - "template": 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}/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.", - "tags": [ - "copilot" - ], - "operationId": "copilot/get-copilot-seat-details-for-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-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" - } - } - ], - "responses": { - "200": { - "description": "The user's GitHub Copilot seat details, including usage.", - "content": { - "application/json": { - "schema": { - "title": "Copilot Business Seat Detail", - "description": "Information about a Copilot Business seat assignment for a user, team, or organization.", - "type": "object", - "properties": { - "assignee": { - "anyOf": [ - { - "type": "null" + "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 }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + "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 }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" + "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" }, - { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - } + "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 }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - } - ] - }, - "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", - "null" - ] - }, - "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", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] - } - ] - } + "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 }, - "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", - "examples": [ - "disabled | all" - ] - }, - "organization_selection_type": { - "type": "string", - "examples": [ - "disabled | all" - ] - }, - "group_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "62ab9291-fae2-468e-974b-7e45096d5021" - ] - }, - "group_name": { - "type": [ - "string", - "null" - ], - "examples": [ - "Justice League" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "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" - } + "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" }, - "required": [ - "id", - "url", - "members_url", - "name", - "html_url", - "slug", - "created_at", - "updated_at" - ] - } - ], - "type": [ - "null", - "object" - ] - }, - "pending_cancellation_date": { - "type": [ - "string", - "null" - ], - "format": "date", - "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", - "null" - ], - "format": "date-time", - "description": "Timestamp of user's last GitHub Copilot activity, in ISO 8601 format." - }, - "last_activity_editor": { - "type": [ - "string", - "null" - ], - "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": { - "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 + "forks": 1, + "open_issues": 1, + "watchers": 1 + }, + "author_association": "COLLABORATOR" } - } - } - } - } - } - }, - "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": { + }, + "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" } } } @@ -120550,30 +118111,27 @@ } } } - }, - "422": { - "description": "Copilot Business or Enterprise is not enabled for this organization or the user has a pending organization invitation." } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-user-management" + "enabledForGitHubApps": false, + "category": "issues", + "subcategory": "issues" } } }, - "/orgs/{org}/memberships/{username}": { + "/orgs/{org}/members": { "get": { - "summary": "Get organization membership for a user", - "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status.", + "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": [ "orgs" ], - "operationId": "orgs/get-membership-for-user", + "operationId": "orgs/list-members", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user" + "url": "https://docs.github.com/rest/orgs/members#list-organization-members" }, "parameters": [ { @@ -120586,12 +118144,51 @@ } }, { - "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": "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 } } ], @@ -120601,384 +118198,180 @@ "content": { "application/json": { "schema": { - "title": "Org Membership", - "description": "Org Membership", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/memberships/defunkt" - ] - }, - "state": { - "type": "string", - "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", - "enum": [ - "active", - "pending" - ], - "examples": [ - "active" - ] - }, - "role": { - "type": "string", - "description": "The user's membership type in the organization.", - "enum": [ - "admin", - "member", - "billing_manager" - ], - "examples": [ - "admin" - ] - }, - "direct_membership": { - "type": "boolean", - "description": "Whether the user has direct membership in the organization.", - "examples": [ - true - ] - }, - "enterprise_teams_providing_indirect_membership": { - "type": "array", - "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", - "maxItems": 100, - "items": { - "type": "string" + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - "examples": [ - "ent:team-one", - "ent:team-two" - ] - }, - "organization_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat" - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - } + "email": { + "type": [ + "string", + "null" + ] }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "permissions": { - "type": "object", - "properties": { - "can_create_repository": { - "type": "boolean" - } + "login": { + "type": "string", + "examples": [ + "octocat" + ] }, - "required": [ - "can_create_repository" - ] - } - }, - "required": [ - "state", - "role", - "organization_url", - "url", - "organization", - "user" - ] + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } }, "examples": { - "response-if-user-has-an-active-admin-membership-with-organization": { - "summary": "Response if user has an active admin membership with organization", - "value": { - "url": "https://api.github.com/orgs/octocat/memberships/defunkt", - "state": "active", - "role": "admin", - "organization_url": "https://api.github.com/orgs/octocat", - "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" - }, - "user": { + "default": { + "value": [ + { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -120998,20 +118391,32 @@ "type": "User", "site_admin": false } - } + ] } } } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } } }, - "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" @@ -121019,16 +118424,163 @@ "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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" + } + }, + { + "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": { + "type": "string" + } + } + } + }, + "404": { + "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", @@ -121063,19 +118615,39 @@ "category": "orgs", "subcategory": "members" } - }, - "put": { - "summary": "Set organization membership for a user", - "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", + } + }, + "/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": [ - "orgs" + "codespaces" ], - "operationId": "orgs/set-membership-for-user", + "operationId": "codespaces/get-codespaces-for-user-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/members#set-organization-membership-for-a-user" + "url": "https://docs.github.com/rest/codespaces/organizations#list-codespaces-for-a-user-in-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": "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.", @@ -121095,733 +118667,231 @@ } } ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "role": { - "type": "string", - "description": "The role to give the user in the organization. Can be one of: \n * `admin` - The user will become an owner of the organization. \n * `member` - The user will become a non-owner member of the organization.", - "enum": [ - "admin", - "member" - ], - "default": "member" - } - } - }, - "examples": { - "default": { - "summary": "Set an organization membership role for a user", - "value": { - "role": "member" - } - } - } - } - } - }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Org Membership", - "description": "Org Membership", "type": "object", + "required": [ + "total_count", + "codespaces" + ], "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/memberships/defunkt" - ] - }, - "state": { - "type": "string", - "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", - "enum": [ - "active", - "pending" - ], - "examples": [ - "active" - ] - }, - "role": { - "type": "string", - "description": "The user's membership type in the organization.", - "enum": [ - "admin", - "member", - "billing_manager" - ], - "examples": [ - "admin" - ] - }, - "direct_membership": { - "type": "boolean", - "description": "Whether the user has direct membership in the organization.", - "examples": [ - true - ] + "total_count": { + "type": "integer" }, - "enterprise_teams_providing_indirect_membership": { - "type": "array", - "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", - "maxItems": 100, - "items": { - "type": "string" - }, - "examples": [ - "ent:team-one", - "ent:team-two" - ] - }, - "organization_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat" - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "permissions": { - "type": "object", - "properties": { - "can_create_repository": { - "type": "boolean" - } - }, - "required": [ - "can_create_repository" - ] - } - }, - "required": [ - "state", - "role", - "organization_url", - "url", - "organization", - "user" - ] - }, - "examples": { - "response-if-user-already-had-membership-with-organization": { - "summary": "Response if user has an active admin membership with organization", - "value": { - "url": "https://api.github.com/orgs/octocat/memberships/defunkt", - "state": "active", - "role": "admin", - "organization_url": "https://api.github.com/orgs/octocat", - "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" - }, - "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 - } - } - } - } - } - } - }, - "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": { + "codespaces": { "type": "array", "items": { "type": "object", - "required": [ - "code" - ], + "title": "Codespace", + "description": "A codespace.", "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] }, - "message": { - "type": "string" + "name": { + "description": "Automatically generated name of this codespace.", + "type": "string", + "examples": [ + "monalisa-octocat-hello-world-g4wpq6h95q" + ] }, - "code": { - "type": "string" + "display_name": { + "description": "Display name for this codespace.", + "type": [ + "string", + "null" + ], + "examples": [ + "bookish space pancake" + ] }, - "index": { - "type": "integer" + "environment_id": { + "description": "UUID identifying this codespace's environment.", + "type": [ + "string", + "null" + ], + "examples": [ + "26a7c758-7299-4a73-b978-5a92a7ae98a0" + ] }, - "value": { - "oneOf": [ - { + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { "type": [ "string", "null" ] }, - { + "email": { "type": [ - "integer", + "string", "null" ] }, - { + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { "type": [ - "array", + "string", "null" ], - "items": { - "type": "string" - } + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] - } - } - } - } - } - } - } - } - }, - "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": "members" - } - }, - "delete": { - "summary": "Remove organization membership for a user", - "description": "In order to remove a user's membership with an organization, the authenticated user must be an organization owner.\n\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.\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-membership-for-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/members#remove-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" - } - }, - { - "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": { - "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": "members" - } - } - }, - "/orgs/{org}/migrations": { - "get": { - "summary": "List organization migrations", - "description": "Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API).\n\nA list of `repositories` is only returned for export migrations.", - "tags": [ - "migrations" - ], - "operationId": "migrations/list-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/migrations/orgs#list-organization-migrations" - }, - "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": "exclude", - "description": "Exclude attributes from the API response to improve performance", - "in": "query", - "schema": { - "type": "array", - "items": { - "description": "Allowed values that can be passed to the exclude param.", - "enum": [ - "repositories" - ], - "type": "string", - "examples": [ - "repositories" - ] - } - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Migration", - "description": "A migration.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 79 - ] - }, - "owner": { - "anyOf": [ - { - "type": "null" }, - { + "billable_owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -121988,1088 +119058,1261 @@ "type", "url" ] - } - ] - }, - "guid": { - "type": "string", - "examples": [ - "0b989ba4-242f-11e5-81e1-c7b6966d2516" - ] - }, - "state": { - "type": "string", - "examples": [ - "pending" - ] - }, - "lock_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "exclude_metadata": { - "type": "boolean" - }, - "exclude_git_data": { - "type": "boolean" - }, - "exclude_attachments": { - "type": "boolean" - }, - "exclude_releases": { - "type": "boolean" - }, - "exclude_owner_projects": { - "type": "boolean" - }, - "org_metadata_only": { - "type": "boolean" - }, - "repositories": { - "type": "array", - "description": "The repositories included in the migration. Only returned for export migrations.", - "items": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" + }, + "repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" + }, + "role_name": { + "type": "string", + "examples": [ + "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", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# 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", + "null" + ], + "format": "uri" + } }, - "maintain": { - "type": "boolean" + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } } }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "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" + ] + } + } + } } }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] + "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 + } }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "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" + ] + }, + "machine": { + "anyOf": [ + { + "type": "null" + }, + { + "type": "object", + "title": "Codespace machine", + "description": "A description of the machine powering a codespace.", + "properties": { + "name": { + "type": "string", + "description": "The name of the machine.", + "examples": [ + "standardLinux" + ] + }, + "display_name": { + "type": "string", + "description": "The display name of the machine includes cores, memory, and storage.", + "examples": [ + "4 cores, 16 GB RAM, 64 GB storage" + ] + }, + "operating_system": { + "type": "string", + "description": "The operating system of the machine.", + "examples": [ + "linux" + ] + }, + "storage_in_bytes": { + "type": "integer", + "description": "How much storage is available to the codespace.", + "examples": [ + 68719476736 + ] + }, + "memory_in_bytes": { + "type": "integer", + "description": "How much memory is available to the codespace.", + "examples": [ + 17179869184 + ] + }, + "cpus": { + "type": "integer", + "description": "How many cores are available to the codespace.", + "examples": [ + 4 + ] + }, + "prebuild_availability": { + "type": [ + "string", + "null" + ], + "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.", + "enum": [ + "none", + "ready", + "in_progress", + null + ], + "examples": [ + "ready" + ] + } + }, + "required": [ + "name", + "display_name", + "operating_system", + "storage_in_bytes", + "memory_in_bytes", + "cpus", + "prebuild_availability" + ] } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { + ] + }, + "devcontainer_path": { + "description": "Path to devcontainer.json from repo root used to create Codespace.", + "type": [ + "string", + "null" + ], + "examples": [ + ".devcontainer/example/devcontainer.json" + ] + }, + "prebuild": { + "description": "Whether the codespace was created from a prebuild.", + "type": [ + "boolean", + "null" + ], + "examples": [ + false + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "last_used_at": { + "description": "Last known time this codespace was started.", + "type": "string", + "format": "date-time", + "examples": [ + "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" + ], + "type": "string", + "examples": [ + "Available" + ] + }, + "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", + "examples": [ + 0 + ] + }, + "behind": { + "description": "The number of commits the local repository is behind the remote.", + "type": "integer", + "examples": [ + 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", + "examples": [ + "main" + ] + } + } + }, + "location": { + "description": "The initally assigned location of a new codespace.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], + "type": "string", + "examples": [ + "WestUs2" + ] + }, + "idle_timeout_minutes": { + "description": "The number of minutes of inactivity after which this codespace will be automatically stopped.", + "type": [ + "integer", + "null" + ], + "examples": [ + 60 + ] + }, + "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", + "null" + ], + "format": "uri" + }, + "pulls_url": { + "description": "API URL for the Pull Request associated with this codespace, if any.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "recent_folders": { + "type": "array", + "items": { "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { + } + }, + "runtime_constraints": { + "type": "object", + "properties": { + "allowed_port_privacy_settings": { + "description": "The privacy settings a user can select from when forwarding a port.", + "type": [ + "array", + "null" + ], + "items": { "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" - ] - } - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octo-org/migrations/79" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2015-07-06T15:33:38-07:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2015-07-06T15:33:38-07:00" + "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", + "null" + ] + }, + "pending_operation_disabled_reason": { + "description": "Text to show user when codespace is disabled by a pending operation", + "type": [ + "string", + "null" + ] + }, + "idle_timeout_notice": { + "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy", + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ], + "examples": [ + 60 + ] + }, + "retention_expires_at": { + "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T20:01:12Z" + ] + }, + "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", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] + } + }, + "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" ] - }, - "node_id": { - "type": "string" - }, - "archive_url": { - "type": "string", - "format": "uri" - }, - "exclude": { - "description": "Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `\"repositories\"`.", - "type": "array", - "items": { - "description": "Allowed values that can be passed to the exclude parameter. The array can include any of: `\"repositories\"`.", - "type": "string" - } } - }, - "required": [ - "id", - "node_id", - "owner", - "guid", - "state", - "lock_repositories", - "exclude_metadata", - "exclude_git_data", - "exclude_attachments", - "exclude_releases", - "exclude_owner_projects", - "org_metadata_only", - "repositories", - "url", - "created_at", - "updated_at" - ] + } } }, "examples": { "default": { - "value": [ - { - "id": 79, - "owner": { - "login": "github", + "value": { + "total_count": 3, + "codespaces": [ + { "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 - }, - "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "state": "pending", - "lock_repositories": true, - "exclude_attachments": false, - "exclude_releases": false, - "exclude_owner_projects": false, - "repositories": [ - { + "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", @@ -123136,78 +120379,434 @@ "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 + "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 }, - "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://api.github.com/licenses/mit" + "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 }, - "forks": 1, - "open_issues": 1, - "watchers": 1 - } - ], - "url": "https://api.github.com/orgs/octo-org/migrations/79", - "created_at": "2015-07-06T15:33:38-07:00", - "updated_at": "2015-07-06T15:33:38-07:00", - "node_id": "MDQ6VXNlcjE=" - } - ] + "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\"", + } + }, + "304": { + "description": "Not modified" + }, + "500": { + "description": "Internal Error", + "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" + } + } + } + } + } + }, + "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" + } + } } } } @@ -123216,20 +120815,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "category": "migrations", - "subcategory": "orgs" + "category": "codespaces", + "subcategory": "organizations" } - }, - "post": { - "summary": "Start an organization migration", - "description": "Initiates the generation of a migration archive.", + } + }, + "/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": [ - "migrations" + "codespaces" ], - "operationId": "migrations/start-for-org", + "operationId": "codespaces/delete-from-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/migrations/orgs#start-an-organization-migration" + "url": "https://docs.github.com/rest/codespaces/organizations#delete-a-codespace-from-the-organization" }, "parameters": [ { @@ -123240,1685 +120841,610 @@ "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" + } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "repositories": { - "type": "array", - "description": "A list of arrays indicating which repositories should be migrated.", - "items": { + "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" } - }, - "lock_repositories": { - "type": "boolean", - "description": "Indicates whether repositories should be locked (to prevent manipulation) while migrating data.", - "default": false, - "examples": [ - true - ] - }, - "exclude_metadata": { - "type": "boolean", - "description": "Indicates whether metadata should be excluded and only git source should be included for the migration.", - "default": false - }, - "exclude_git_data": { - "type": "boolean", - "description": "Indicates whether the repository git data should be excluded from the migration.", - "default": false - }, - "exclude_attachments": { - "type": "boolean", - "description": "Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).", - "default": false, - "examples": [ - true - ] - }, - "exclude_releases": { - "type": "boolean", - "description": "Indicates whether releases should be excluded from the migration (to reduce migration archive file size).", - "default": false, - "examples": [ - true - ] - }, - "exclude_owner_projects": { - "type": "boolean", - "description": "Indicates whether projects owned by the organization or users should be excluded. from the migration.", - "default": false, - "examples": [ - true - ] - }, - "org_metadata_only": { - "type": "boolean", - "description": "Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).", - "default": false, - "examples": [ - true - ] - }, - "exclude": { - "type": "array", - "description": "Exclude related items from being returned in the response in order to improve performance of the request.", - "items": { - "type": "string", - "enum": [ - "repositories" - ] + } + } + } + } + }, + "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": [ - "repositories" - ] - }, - "examples": { - "default": { - "value": { - "repositories": [ - "github/Hello-World" - ], - "lock_repositories": 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": { + "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": { - "201": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Migration", - "description": "A migration.", "type": "object", + "title": "Codespace", + "description": "A codespace.", "properties": { "id": { "type": "integer", "format": "int64", "examples": [ - 79 - ] - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + 1 ] }, - "guid": { + "name": { + "description": "Automatically generated name of this codespace.", "type": "string", "examples": [ - "0b989ba4-242f-11e5-81e1-c7b6966d2516" + "monalisa-octocat-hello-world-g4wpq6h95q" ] }, - "state": { - "type": "string", + "display_name": { + "description": "Display name for this codespace.", + "type": [ + "string", + "null" + ], "examples": [ - "pending" + "bookish space pancake" ] }, - "lock_repositories": { - "type": "boolean", + "environment_id": { + "description": "UUID identifying this codespace's environment.", + "type": [ + "string", + "null" + ], "examples": [ - true + "26a7c758-7299-4a73-b978-5a92a7ae98a0" ] }, - "exclude_metadata": { - "type": "boolean" - }, - "exclude_git_data": { - "type": "boolean" - }, - "exclude_attachments": { - "type": "boolean" - }, - "exclude_releases": { - "type": "boolean" - }, - "exclude_owner_projects": { - "type": "boolean" - }, - "org_metadata_only": { - "type": "boolean" - }, - "repositories": { - "type": "array", - "description": "The repositories included in the migration. Only returned for export migrations.", - "items": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } - } + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - "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" - ] - } - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octo-org/migrations/79" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2015-07-06T15:33:38-07:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2015-07-06T15:33:38-07:00" - ] - }, - "node_id": { - "type": "string" - }, - "archive_url": { - "type": "string", - "format": "uri" - }, - "exclude": { - "description": "Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `\"repositories\"`.", - "type": "array", - "items": { - "description": "Allowed values that can be passed to the exclude parameter. The array can include any of: `\"repositories\"`.", - "type": "string" - } - } - }, - "required": [ - "id", - "node_id", - "owner", - "guid", - "state", - "lock_repositories", - "exclude_metadata", - "exclude_git_data", - "exclude_attachments", - "exclude_releases", - "exclude_owner_projects", - "org_metadata_only", - "repositories", - "url", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 79, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "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 - }, - "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "state": "pending", - "lock_repositories": true, - "exclude_attachments": false, - "exclude_releases": false, - "exclude_owner_projects": false, - "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" + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" ], - "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://api.github.com/licenses/mit" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } - ], - "url": "https://api.github.com/orgs/octo-org/migrations/79", - "created_at": "2015-07-06T15:33:38-07:00", - "updated_at": "2015-07-06T15:33:38-07:00" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/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" + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } + "billable_owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "migrations", - "subcategory": "orgs" - } - } - }, - "/orgs/{org}/migrations/{migration_id}": { - "get": { - "summary": "Get an organization migration status", - "description": "Fetches the status of a migration.\n\nThe `state` of a migration can be one of the following values:\n\n* `pending`, which means the migration hasn't started yet.\n* `exporting`, which means the migration is in progress.\n* `exported`, which means the migration finished successfully.\n* `failed`, which means the migration failed.", - "tags": [ - "migrations" - ], - "operationId": "migrations/get-status-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "migration_id", - "description": "The unique identifier of the migration.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "exclude", - "description": "Exclude attributes from the API response to improve performance", - "in": "query", - "schema": { - "type": "array", - "items": { - "description": "Allowed values that can be passed to the exclude param.", - "enum": [ - "repositories" - ], - "type": "string", - "examples": [ - "repositories" - ] - } - } - } - ], - "responses": { - "200": { - "description": "* `pending`, which means the migration hasn't started yet.\n* `exporting`, which means the migration is in progress.\n* `exported`, which means the migration finished successfully.\n* `failed`, which means the migration failed.", - "content": { - "application/json": { - "schema": { - "title": "Migration", - "description": "A migration.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 79 + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, - "owner": { - "anyOf": [ - { - "type": "null" + "repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] }, - { + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -125085,1068 +121611,1023 @@ "type", "url" ] - } - ] - }, - "guid": { - "type": "string", - "examples": [ - "0b989ba4-242f-11e5-81e1-c7b6966d2516" - ] - }, - "state": { - "type": "string", - "examples": [ - "pending" - ] - }, - "lock_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "exclude_metadata": { - "type": "boolean" - }, - "exclude_git_data": { - "type": "boolean" - }, - "exclude_attachments": { - "type": "boolean" - }, - "exclude_releases": { - "type": "boolean" - }, - "exclude_owner_projects": { - "type": "boolean" - }, - "org_metadata_only": { - "type": "boolean" - }, - "repositories": { - "type": "array", - "description": "The repositories included in the migration. Only returned for export migrations.", - "items": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "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", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# 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", + "null" + ], + "format": "uri" + } }, - "topics": { - "type": "array", - "items": { + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { "type": "string" } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "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" + ] + } } } } }, - "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" - ] - } + "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" + ] }, - "url": { - "type": "string", - "format": "uri", + "machine": { + "anyOf": [ + { + "type": "null" + }, + { + "type": "object", + "title": "Codespace machine", + "description": "A description of the machine powering a codespace.", + "properties": { + "name": { + "type": "string", + "description": "The name of the machine.", + "examples": [ + "standardLinux" + ] + }, + "display_name": { + "type": "string", + "description": "The display name of the machine includes cores, memory, and storage.", + "examples": [ + "4 cores, 16 GB RAM, 64 GB storage" + ] + }, + "operating_system": { + "type": "string", + "description": "The operating system of the machine.", + "examples": [ + "linux" + ] + }, + "storage_in_bytes": { + "type": "integer", + "description": "How much storage is available to the codespace.", + "examples": [ + 68719476736 + ] + }, + "memory_in_bytes": { + "type": "integer", + "description": "How much memory is available to the codespace.", + "examples": [ + 17179869184 + ] + }, + "cpus": { + "type": "integer", + "description": "How many cores are available to the codespace.", + "examples": [ + 4 + ] + }, + "prebuild_availability": { + "type": [ + "string", + "null" + ], + "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.", + "enum": [ + "none", + "ready", + "in_progress", + null + ], + "examples": [ + "ready" + ] + } + }, + "required": [ + "name", + "display_name", + "operating_system", + "storage_in_bytes", + "memory_in_bytes", + "cpus", + "prebuild_availability" + ] + } + ] + }, + "devcontainer_path": { + "description": "Path to devcontainer.json from repo root used to create Codespace.", + "type": [ + "string", + "null" + ], "examples": [ - "https://api.github.com/orgs/octo-org/migrations/79" + ".devcontainer/example/devcontainer.json" + ] + }, + "prebuild": { + "description": "Whether the codespace was created from a prebuild.", + "type": [ + "boolean", + "null" + ], + "examples": [ + false ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2015-07-06T15:33:38-07:00" + "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2015-07-06T15:33:38-07:00" + "2011-01-26T19:01:12Z" ] }, - "node_id": { - "type": "string" + "last_used_at": { + "description": "Last known time this codespace was started.", + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] }, - "archive_url": { + "state": { + "description": "State of this codespace.", + "enum": [ + "Unknown", + "Created", + "Queued", + "Provisioning", + "Available", + "Awaiting", + "Unavailable", + "Deleted", + "Moved", + "Shutdown", + "Archived", + "Starting", + "ShuttingDown", + "Failed", + "Exporting", + "Updating", + "Rebuilding" + ], + "type": "string", + "examples": [ + "Available" + ] + }, + "url": { + "description": "API URL for this codespace.", "type": "string", "format": "uri" }, - "exclude": { - "description": "Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `\"repositories\"`.", + "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", + "examples": [ + 0 + ] + }, + "behind": { + "description": "The number of commits the local repository is behind the remote.", + "type": "integer", + "examples": [ + 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", + "examples": [ + "main" + ] + } + } + }, + "location": { + "description": "The initally assigned location of a new codespace.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], + "type": "string", + "examples": [ + "WestUs2" + ] + }, + "idle_timeout_minutes": { + "description": "The number of minutes of inactivity after which this codespace will be automatically stopped.", + "type": [ + "integer", + "null" + ], + "examples": [ + 60 + ] + }, + "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", + "null" + ], + "format": "uri" + }, + "pulls_url": { + "description": "API URL for the Pull Request associated with this codespace, if any.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "recent_folders": { "type": "array", "items": { - "description": "Allowed values that can be passed to the exclude parameter. The array can include any of: `\"repositories\"`.", "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", + "null" + ], + "items": { + "type": "string" + } + } + } + }, + "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", + "null" + ] + }, + "pending_operation_disabled_reason": { + "description": "Text to show user when codespace is disabled by a pending operation", + "type": [ + "string", + "null" + ] + }, + "idle_timeout_notice": { + "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy", + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ], + "examples": [ + 60 + ] + }, + "retention_expires_at": { + "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T20:01:12Z" + ] + }, + "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", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ "id", - "node_id", + "name", + "environment_id", "owner", - "guid", + "billable_owner", + "repository", + "machine", + "prebuild", + "created_at", + "updated_at", + "last_used_at", "state", - "lock_repositories", - "exclude_metadata", - "exclude_git_data", - "exclude_attachments", - "exclude_releases", - "exclude_owner_projects", - "org_metadata_only", - "repositories", "url", - "created_at", - "updated_at" + "git_status", + "location", + "idle_timeout_minutes", + "web_url", + "machines_url", + "start_url", + "stop_url", + "pulls_url", + "recent_folders" ] }, "examples": { "default": { "value": { - "id": 79, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "id": 1, + "name": "monalisa-octocat-hello-world-g4wpq6h95q", + "environment_id": "26a7c758-7299-4a73-b978-5a92a7ae98a0", "owner": { - "login": "github", + "login": "octocat", "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", + "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", + "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", @@ -126154,152 +122635,145 @@ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", - "site_admin": true + "site_admin": false }, - "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "state": "exported", - "lock_repositories": true, - "exclude_attachments": false, - "exclude_releases": false, - "exclude_owner_projects": false, - "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://api.github.com/licenses/mit" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 - } - ], - "url": "https://api.github.com/orgs/octo-org/migrations/79", - "created_at": "2015-07-06T15:33:38-07:00", - "updated_at": "2015-07-06T15:33:38-07:00" + "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, + "retention_period_minutes": 43200, + "retention_expires_at": null, + "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", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", + "recent_folders": [], + "template": null } } } } } }, - "404": { - "description": "Resource not found", + "304": { + "description": "Not modified" + }, + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -126323,54 +122797,9 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "migrations", - "subcategory": "orgs" - } - } - }, - "/orgs/{org}/migrations/{migration_id}/archive": { - "get": { - "summary": "Download an organization migration archive", - "description": "Fetches the URL to a migration archive.", - "tags": [ - "migrations" - ], - "operationId": "migrations/download-archive-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "migration_id", - "description": "The unique identifier of the migration.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "302": { - "description": "Response" }, - "404": { - "description": "Resource not found", + "401": { + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -126394,52 +122823,9 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "migrations", - "subcategory": "orgs" - } - }, - "delete": { - "summary": "Delete an organization migration archive", - "description": "Deletes a previous migration archive. Migration archives are automatically deleted after seven days.", - "tags": [ - "migrations" - ], - "operationId": "migrations/delete-archive-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "migration_id", - "description": "The unique identifier of the migration.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" }, - "404": { - "description": "Resource not found", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -126463,60 +122849,6 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "migrations", - "subcategory": "orgs" - } - } - }, - "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock": { - "delete": { - "summary": "Unlock an organization repository", - "description": "Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data.", - "tags": [ - "migrations" - ], - "operationId": "migrations/unlock-repo-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "migration_id", - "description": "The unique identifier of the migration.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "repo_name", - "description": "repo_name parameter", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" }, "404": { "description": "Resource not found", @@ -126548,22 +122880,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "category": "migrations", - "subcategory": "orgs" + "category": "codespaces", + "subcategory": "organizations" } } }, - "/orgs/{org}/migrations/{migration_id}/repositories": { + "/orgs/{org}/members/{username}/copilot": { "get": { - "summary": "List repositories in an organization migration", - "description": "List all the repositories for this organization migration.", + "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 [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": [ - "migrations" + "copilot" ], - "operationId": "migrations/list-repos-for-org", + "operationId": "copilot/get-copilot-seat-details-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration" + "url": "https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-user" }, "parameters": [ { @@ -126576,1950 +122908,26 @@ } }, { - "name": "migration_id", - "description": "The unique identifier of the migration.", + "name": "username", + "description": "The handle for the GitHub user account.", "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 + "type": "string" } } ], "responses": { "200": { - "description": "Response", + "description": "The user's GitHub Copilot seat details, including usage.", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "examples": [ - "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", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# 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", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "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": [ - { - "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": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "has_discussions": false, - "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 - }, - "security_and_analysis": { - "advanced_security": { - "status": "enabled" - }, - "secret_scanning": { - "status": "enabled" - }, - "secret_scanning_push_protection": { - "status": "disabled" - }, - "secret_scanning_non_provider_patterns": { - "status": "disabled" - } - } - } - ] - } - } - } - }, - "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": false, - "category": "migrations", - "subcategory": "orgs" - } - } - }, - "/orgs/{org}/organization-roles": { - "get": { - "summary": "Get all organization roles for an organization", - "description": "Lists the organization roles available in this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/list-org-roles", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/organization-roles#get-all-organization-roles-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 - list of organization roles", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "total_count": { - "type": "integer", - "description": "The total number of organization roles available to the organization." - }, - "roles": { - "type": "array", - "description": "The list of organization roles available to the organization.", - "items": { - "title": "Organization Role", - "description": "Organization roles", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the role.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "The name of the role.", - "type": "string" - }, - "description": { - "description": "A short description about who this role is for or what permissions it grants.", - "type": [ - "string", - "null" - ] - }, - "base_role": { - "type": [ - "string", - "null" - ], - "description": "The system role from which this role inherits permissions.", - "enum": [ - "read", - "triage", - "write", - "maintain", - "admin", - null - ] - }, - "source": { - "type": [ - "string", - "null" - ], - "description": "Source answers the question, \"where did this role come from?\"", - "enum": [ - "Organization", - "Enterprise", - "Predefined", - null - ] - }, - "permissions": { - "description": "A list of permissions included in this role.", - "type": "array", - "items": { - "type": "string" - } - }, - "organization": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "description": "The date and time the role was created.", - "type": "string", - "format": "date-time" - }, - "updated_at": { - "description": "The date and time the role was last updated.", - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "name", - "permissions", - "organization", - "created_at", - "updated_at" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 2, - "roles": [ - { - "id": 8030, - "name": "Custom Role Manager", - "description": "Permissions to manage custom roles within an org", - "permissions": [ - "write_organization_custom_repo_role", - "write_organization_custom_org_role", - "read_organization_custom_repo_role", - "read_organization_custom_org_role" - ], - "organization": { - "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 - }, - "created_at": "2022-07-04T22:19:11Z", - "updated_at": "2022-07-04T22:20:11Z" - }, - { - "id": 8031, - "name": "Auditor", - "description": "Permissions to read the organization audit log", - "permissions": [ - "read_audit_logs" - ], - "organization": { - "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 - }, - "created_at": "2022-07-04T22:19:11Z", - "updated_at": "2022-07-04T22:20:11Z" - } - ] - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "organization-roles" - } - } - }, - "/orgs/{org}/organization-roles/teams/{team_slug}": { - "delete": { - "summary": "Remove all organization roles for a team", - "description": "Removes all assigned organization roles from a team. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/revoke-all-org-roles-team", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "organization-roles" - } - } - }, - "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}": { - "put": { - "summary": "Assign an organization role to a team", - "description": "Assigns an organization role to a team in an organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/assign-team-to-org-role", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-team" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "role_id", - "description": "The unique identifier of the role.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "404": { - "description": "Response if the organization, team or role does not exist." - }, - "422": { - "description": "Response if the organization roles feature is not enabled for the organization, or validation failed." - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "organization-roles" - } - }, - "delete": { - "summary": "Remove an organization role from a team", - "description": "Removes an organization role from a team. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/revoke-org-role-team", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-team" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "role_id", - "description": "The unique identifier of the role.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "organization-roles" - } - } - }, - "/orgs/{org}/organization-roles/users/{username}": { - "delete": { - "summary": "Remove all organization roles for a user", - "description": "Revokes all assigned organization roles from a user. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/revoke-all-org-roles-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-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" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "organization-roles" - } - } - }, - "/orgs/{org}/organization-roles/users/{username}/{role_id}": { - "put": { - "summary": "Assign an organization role to a user", - "description": "Assigns an organization role to a member of an organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/assign-user-to-org-role", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-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": "role_id", - "description": "The unique identifier of the role.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "404": { - "description": "Response if the organization, user or role does not exist." - }, - "422": { - "description": "Response if the organization roles feature is not enabled enabled for the organization, the validation failed, or the user is not an organization member." - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "organization-roles" - } - }, - "delete": { - "summary": "Remove an organization role from a user", - "description": "Remove an organization role from a user. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/revoke-org-role-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-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": "role_id", - "description": "The unique identifier of the role.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "organization-roles" - } - } - }, - "/orgs/{org}/organization-roles/{role_id}": { - "get": { - "summary": "Get an organization role", - "description": "Gets an organization role that is available to this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/get-org-role", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "role_id", - "description": "The unique identifier of the role.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Organization Role", - "description": "Organization roles", + "title": "Copilot Business Seat Detail", + "description": "Information about a Copilot Business seat assignment for a user, team, or organization.", "type": "object", "properties": { - "id": { - "description": "The unique identifier of the role.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "The name of the role.", - "type": "string" - }, - "description": { - "description": "A short description about who this role is for or what permissions it grants.", - "type": [ - "string", - "null" - ] - }, - "base_role": { - "type": [ - "string", - "null" - ], - "description": "The system role from which this role inherits permissions.", - "enum": [ - "read", - "triage", - "write", - "maintain", - "admin", - null - ] - }, - "source": { - "type": [ - "string", - "null" - ], - "description": "Source answers the question, \"where did this role come from?\"", - "enum": [ - "Organization", - "Enterprise", - "Predefined", - null - ] - }, - "permissions": { - "description": "A list of permissions included in this role.", - "type": "array", - "items": { - "type": "string" - } - }, - "organization": { + "assignee": { "anyOf": [ { "type": "null" @@ -128694,455 +123102,492 @@ } ] }, - "created_at": { - "description": "The date and time the role was created.", - "type": "string", - "format": "date-time" - }, - "updated_at": { - "description": "The date and time the role was last updated.", - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "name", - "permissions", - "organization", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 8030, - "name": "Custom Role Manager", - "description": "Permissions to manage custom roles within an org", - "permissions": [ - "write_organization_custom_repo_role", - "write_organization_custom_org_role", - "read_organization_custom_repo_role", - "read_organization_custom_org_role" - ], - "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" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/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" + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ] + }, + "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", + "null" + ] + }, + "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" + } }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] } - } - ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "organization-roles" - } - } - }, - "/orgs/{org}/organization-roles/{role_id}/teams": { - "get": { - "summary": "List teams that are assigned to an organization role", - "description": "Lists the teams that are assigned to an organization role. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, you must be an administrator for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/list-org-role-teams", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "role_id", - "description": "The unique identifier of the role.", - "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 - List of assigned teams", - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "List of teams assigned to the organization role", - "items": { - "title": "A Role Assignment for a Team", - "description": "The Relationship a Team has with a role.", - "type": "object", - "properties": { - "assignment": { - "type": "string", - "description": "Determines if the team has a direct, indirect, or mixed relationship to a role", - "enum": [ - "direct", - "indirect", - "mixed" - ], - "examples": [ - "direct" - ] - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "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": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } + { + "title": "Enterprise Team", + "description": "Group of enterprise owners and/or members", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] - } - ] - } + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "sync_to_organizations": { + "type": "string", + "examples": [ + "disabled | all" + ] + }, + "organization_selection_type": { + "type": "string", + "examples": [ + "disabled | all" + ] + }, + "group_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "62ab9291-fae2-468e-974b-7e45096d5021" + ] + }, + "group_name": { + "type": [ + "string", + "null" + ], + "examples": [ + "Justice League" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "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" + ] + } + ], + "type": [ + "null", + "object" + ] }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] - } + "pending_cancellation_date": { + "type": [ + "string", + "null" + ], + "format": "date", + "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", + "null" + ], + "format": "date-time", + "description": "Timestamp of user's last GitHub Copilot activity, in ISO 8601 format." + }, + "last_activity_editor": { + "type": [ + "string", + "null" + ], + "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": [ - { + "value": { + "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", @@ -129157,46 +123602,139 @@ "repositories_url": "https://api.github.com/teams/1/repos", "parent": null } - ] + } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", + } + }, + "500": { + "description": "Internal Error", + "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" + } + } + } + } + } + }, + "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": "Response if the organization or role does not exist." + "description": "Resource not found", + "content": { + "application/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": "Response if the organization roles feature is not enabled or validation failed." + "description": "Copilot Business or Enterprise is not enabled for this organization or the user has a pending organization invitation." } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "organization-roles" + "category": "copilot", + "subcategory": "copilot-user-management" } } }, - "/orgs/{org}/organization-roles/{role_id}/users": { + "/orgs/{org}/memberships/{username}": { "get": { - "summary": "List users that are assigned to an organization role", - "description": "Lists organization members that are assigned to an organization role. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, you must be an administrator for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Get organization membership for a user", + "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status.", "tags": [ "orgs" ], - "operationId": "orgs/list-org-role-users", + "operationId": "orgs/get-membership-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role" + "url": "https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user" }, "parameters": [ { @@ -129209,69 +123747,211 @@ } }, { - "name": "role_id", - "description": "The unique identifier of the role.", + "name": "username", + "description": "The handle for the GitHub user account.", "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 + "type": "string" } } ], "responses": { "200": { - "description": "Response - List of assigned users", + "description": "Response", "content": { "application/json": { "schema": { - "type": "array", - "description": "List of users assigned to the organization role", - "items": { - "title": "A Role Assignment for a User", - "description": "The Relationship a User has with a role.", - "type": "object", - "properties": { - "assignment": { - "type": "string", - "description": "Determines if the user has a direct, indirect, or mixed relationship to a role", - "enum": [ - "direct", - "indirect", - "mixed" - ], - "examples": [ - "direct" - ] + "title": "Org Membership", + "description": "Org Membership", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/memberships/defunkt" + ] + }, + "state": { + "type": "string", + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "enum": [ + "active", + "pending" + ], + "examples": [ + "active" + ] + }, + "role": { + "type": "string", + "description": "The user's membership type in the organization.", + "enum": [ + "admin", + "member", + "billing_manager" + ], + "examples": [ + "admin" + ] + }, + "direct_membership": { + "type": "boolean", + "description": "Whether the user has direct membership in the organization.", + "examples": [ + true + ] + }, + "enterprise_teams_providing_indirect_membership": { + "type": "array", + "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", + "maxItems": 100, + "items": { + "type": "string" }, - "inherited_from": { - "description": "Team the user has gotten the role through", - "type": "array", - "items": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", + "examples": [ + "ent:team-one", + "ent:team-two" + ] + }, + "organization_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, "id": { - "description": "Unique identifier of the team", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -129279,554 +123959,187 @@ "node_id": { "type": "string", "examples": [ - "MDQ6VGVhbTE=" + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" ] }, "url": { - "description": "URL for the team", "type": "string", "format": "uri", "examples": [ - "https://api.github.com/organizations/1/team/1" + "https://api.github.com/users/octocat" ] }, - "members_url": { + "html_url": { "type": "string", + "format": "uri", "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" + "https://github.com/octocat" ] }, - "name": { - "description": "Name of the team", + "followers_url": { "type": "string", + "format": "uri", "examples": [ - "Justice League" + "https://api.github.com/users/octocat/followers" ] }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], + "following_url": { + "type": "string", "examples": [ - "A great team." + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "permission": { - "description": "Permission that the team will have for its repositories", + "gists_url": { "type": "string", "examples": [ - "admin" + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "privacy": { - "description": "The level of privacy this team should have", + "starred_url": { "type": "string", "examples": [ - "closed" + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "notification_setting": { - "description": "The notification setting the team has set", + "subscriptions_url": { "type": "string", + "format": "uri", "examples": [ - "notifications_enabled" + "https://api.github.com/users/octocat/subscriptions" ] }, - "html_url": { + "organizations_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/orgs/rails/teams/core" + "https://api.github.com/users/octocat/orgs" ] }, - "repositories_url": { + "repos_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/organizations/1/team/1/repos" + "https://api.github.com/users/octocat/repos" ] }, - "slug": { + "events_url": { "type": "string", "examples": [ - "justice-league" + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { "type": "string", "examples": [ - "uid=example,ou=users,dc=github,dc=com" + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", "id", "node_id", - "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" ] } - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + ] }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "permissions": { + "type": "object", + "properties": { + "can_create_repository": { + "type": "boolean" + } + }, + "required": [ + "can_create_repository" + ] + } + }, + "required": [ + "state", + "role", + "organization_url", + "url", + "organization", + "user" + ] }, "examples": { - "default": { - "value": [ - { - "login": "octocat", + "response-if-user-has-an-active-admin-membership-with-organization": { + "summary": "Response if user has an active admin membership with organization", + "value": { + "url": "https://api.github.com/orgs/octocat/memberships/defunkt", + "state": "active", + "role": "admin", + "organization_url": "https://api.github.com/orgs/octocat", + "organization": { + "login": "github", "id": 1, - "node_id": "MDQ6VXNlcjE=", + "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", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "404": { - "description": "Response if the organization or role does not exist." - }, - "422": { - "description": "Response if the organization roles feature is not enabled or validation failed." - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "organization-roles" - } - } - }, - "/orgs/{org}/outside_collaborators": { - "get": { - "summary": "List outside collaborators for an organization", - "description": "List all users who are outside collaborators of an organization.", - "tags": [ - "orgs" - ], - "operationId": "orgs/list-outside-collaborators", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "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) enabled will be returned. `2fa_insecure` means that only outside collaborators 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.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "2fa_disabled", - "2fa_insecure", - "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", - "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": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "description": "A great organization" }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "examples": { - "default": { - "value": [ - { + "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -129846,116 +124159,40 @@ "type": "User", "site_admin": false } - ] + } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "outside-collaborators" - } - } - }, - "/orgs/{org}/outside_collaborators/{username}": { - "put": { - "summary": "Convert an organization member to outside collaborator", - "description": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"[Converting an organization member to an outside collaborator](https://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)\". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"", - "tags": [ - "orgs" - ], - "operationId": "orgs/convert-member-to-outside-collaborator", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator" - }, - "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" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "async": { - "type": "boolean", - "description": "When set to `true`, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.", - "default": false - } - } - }, - "examples": { - "202": { - "summary": "Status code 202, asynchronous request", - "value": { - "async": true - } - }, - "204": { - "summary": "Status code 204, synchronous request", - "value": null - } - } - } - } - }, - "responses": { - "202": { - "description": "User is getting converted asynchronously", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "properties": {}, - "additionalProperties": false - }, - "examples": { - "202": { - "value": null + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } } } } } }, - "204": { - "description": "User was converted" - }, "403": { - "description": "Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"" - }, - "404": { - "description": "Resource not found", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -129985,19 +124222,19 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", - "subcategory": "outside-collaborators" + "subcategory": "members" } }, - "delete": { - "summary": "Remove outside collaborator from an organization", - "description": "Removing a user from this list will remove them from all the organization's repositories.", + "put": { + "summary": "Set organization membership for a user", + "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", "tags": [ "orgs" ], - "operationId": "orgs/remove-outside-collaborator", + "operationId": "orgs/set-membership-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization" + "url": "https://docs.github.com/rest/orgs/members#set-organization-membership-for-a-user" }, "parameters": [ { @@ -130019,1496 +124256,201 @@ } } ], - "responses": { - "204": { - "description": "Response" - }, - "422": { - "description": "Unprocessable Entity if user is a member of the organization", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "role": { + "type": "string", + "description": "The role to give the user in the organization. Can be one of: \n * `admin` - The user will become an owner of the organization. \n * `member` - The user will become a non-owner member of the organization.", + "enum": [ + "admin", + "member" + ], + "default": "member" } - }, - "examples": { - "response-if-user-is-a-member-of-the-organization": { - "value": { - "message": "You cannot specify an organization member to remove as an outside collaborator.", - "documentation_url": "https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization" - } + } + }, + "examples": { + "default": { + "summary": "Set an organization membership role for a user", + "value": { + "role": "member" } } } } } }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "outside-collaborators" - } - } - }, - "/orgs/{org}/packages": { - "get": { - "summary": "List packages for an organization", - "description": "Lists packages in an organization readable by the user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", - "tags": [ - "packages" - ], - "operationId": "packages/list-packages-for-organization", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/packages/packages#list-packages-for-an-organization" - }, - "parameters": [ - { - "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 (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", - "in": "query", - "required": true, - "schema": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - } - }, - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "visibility", - "description": "The selected visibility of the packages. This parameter is optional and only filters an existing result set.\n\nThe `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`.\nFor the list of GitHub Packages registries that support granular permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "public", - "private", - "internal" - ] - } - }, - { - "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": "array", - "items": { - "title": "Package", - "description": "A software package", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the package.", - "type": "integer", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the package.", - "type": "string", - "examples": [ - "super-linter" - ] - }, - "package_type": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ], - "examples": [ - "docker" - ] - }, - "url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/packages/container/super-linter" - ] - }, - "html_url": { - "type": "string", - "examples": [ - "https://github.com/orgs/github/packages/container/package/super-linter" - ] - }, - "version_count": { - "description": "The number of versions of the package.", - "type": "integer", - "examples": [ - 1 - ] - }, - "visibility": { - "type": "string", - "enum": [ - "private", - "public" - ], - "examples": [ - "private" - ] + "title": "Org Membership", + "description": "Org Membership", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/memberships/defunkt" + ] + }, + "state": { + "type": "string", + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "enum": [ + "active", + "pending" + ], + "examples": [ + "active" + ] + }, + "role": { + "type": "string", + "description": "The user's membership type in the organization.", + "enum": [ + "admin", + "member", + "billing_manager" + ], + "examples": [ + "admin" + ] + }, + "direct_membership": { + "type": "boolean", + "description": "Whether the user has direct membership in the organization.", + "examples": [ + true + ] + }, + "enterprise_teams_providing_indirect_membership": { + "type": "array", + "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", + "maxItems": 100, + "items": { + "type": "string" }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "repository": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "examples": [ - "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", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# 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", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "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" - ] - } - ] - }, - "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" - } - } - } - } - } - }, - "400": { - "description": "The value of `per_page` multiplied by `page` cannot be greater than 10000." - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "packages", - "subcategory": "packages" - } - } - }, - "/orgs/{org}/packages/{package_type}/{package_name}": { - "get": { - "summary": "Get a package for an organization", - "description": "Gets a specific package in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", - "tags": [ - "packages" - ], - "operationId": "packages/get-package-for-organization", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization" - }, - "parameters": [ - { - "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 (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", - "in": "path", - "required": true, - "schema": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - } - }, - { - "name": "package_name", - "description": "The name of the package.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "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": "Package", - "description": "A software package", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the package.", - "type": "integer", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the package.", - "type": "string", - "examples": [ - "super-linter" - ] - }, - "package_type": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ], - "examples": [ - "docker" - ] - }, - "url": { - "type": "string", "examples": [ - "https://api.github.com/orgs/github/packages/container/super-linter" + "ent:team-one", + "ent:team-two" ] }, - "html_url": { + "organization_url": { "type": "string", + "format": "uri", "examples": [ - "https://github.com/orgs/github/packages/container/package/super-linter" - ] - }, - "version_count": { - "description": "The number of versions of the package.", - "type": "integer", - "examples": [ - 1 + "https://api.github.com/orgs/octocat" ] }, - "visibility": { - "type": "string", - "enum": [ - "private", - "public" - ], - "examples": [ - "private" + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" ] }, - "owner": { + "user": { "anyOf": [ { "type": "null" @@ -131683,21 +124625,583 @@ } ] }, - "repository": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Minimal Repository", - "description": "Minimal Repository", + "permissions": { + "type": "object", + "properties": { + "can_create_repository": { + "type": "boolean" + } + }, + "required": [ + "can_create_repository" + ] + } + }, + "required": [ + "state", + "role", + "organization_url", + "url", + "organization", + "user" + ] + }, + "examples": { + "response-if-user-already-had-membership-with-organization": { + "summary": "Response if user has an active admin membership with organization", + "value": { + "url": "https://api.github.com/orgs/octocat/memberships/defunkt", + "state": "active", + "role": "admin", + "organization_url": "https://api.github.com/orgs/octocat", + "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" + }, + "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 + } + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "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": "members" + } + }, + "delete": { + "summary": "Remove organization membership for a user", + "description": "In order to remove a user's membership with an organization, the authenticated user must be an organization owner.\n\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.\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-membership-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/members#remove-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" + } + }, + { + "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": { + "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": "members" + } + } + }, + "/orgs/{org}/migrations": { + "get": { + "summary": "List organization migrations", + "description": "Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API).\n\nA list of `repositories` is only returned for export migrations.", + "tags": [ + "migrations" + ], + "operationId": "migrations/list-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/migrations/orgs#list-organization-migrations" + }, + "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": "exclude", + "description": "Exclude attributes from the API response to improve performance", + "in": "query", + "schema": { + "type": "array", + "items": { + "description": "Allowed values that can be passed to the exclude param.", + "enum": [ + "repositories" + ], + "type": "string", + "examples": [ + "repositories" + ] + } + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Migration", + "description": "A migration.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 79 + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "guid": { + "type": "string", + "examples": [ + "0b989ba4-242f-11e5-81e1-c7b6966d2516" + ] + }, + "state": { + "type": "string", + "examples": [ + "pending" + ] + }, + "lock_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "exclude_metadata": { + "type": "boolean" + }, + "exclude_git_data": { + "type": "boolean" + }, + "exclude_attachments": { + "type": "boolean" + }, + "exclude_releases": { + "type": "boolean" + }, + "exclude_owner_projects": { + "type": "boolean" + }, + "org_metadata_only": { + "type": "boolean" + }, + "repositories": { + "type": "array", + "description": "The repositories included in the migration. Only returned for export migrations.", + "items": { + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", "properties": { "id": { + "description": "Unique identifier of the repository", "type": "integer", "format": "int64", "examples": [ - 1296269 + 42 ] }, "node_id": { @@ -131707,9 +125211,10 @@ ] }, "name": { + "description": "The name of the repository.", "type": "string", "examples": [ - "Hello-World" + "Team Environment" ] }, "full_name": { @@ -131718,27 +125223,117 @@ "octocat/Hello-World" ] }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] + "admin": { + "type": "boolean" }, - "email": { - "type": [ - "string", - "null" - ] + "pull": { + "type": "boolean" }, - "login": { - "type": "string", - "examples": [ - "octocat" + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" ] }, "id": { @@ -131887,6 +125482,8 @@ ] }, "private": { + "description": "Whether the repository is private or public.", + "default": false, "type": "boolean" }, "html_url": { @@ -132023,7 +125620,10 @@ ] }, "git_url": { - "type": "string" + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] }, "issue_comment_url": { "type": "string", @@ -132094,7 +125694,10 @@ ] }, "ssh_url": { - "type": "string" + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] }, "stargazers_url": { "type": "string", @@ -132144,12 +125747,19 @@ ] }, "clone_url": { - "type": "string" + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] }, "mirror_url": { "type": [ "string", "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { @@ -132160,12 +125770,20 @@ ] }, "svn_url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] }, "homepage": { "type": [ "string", "null" + ], + "format": "uri", + "examples": [ + "https://github.com" ] }, "language": { @@ -132175,26 +125793,50 @@ ] }, "forks_count": { - "type": "integer" + "type": "integer", + "examples": [ + 9 + ] }, "stargazers_count": { - "type": "integer" + "type": "integer", + "examples": [ + 80 + ] }, "watchers_count": { - "type": "integer" + "type": "integer", + "examples": [ + 80 + ] }, "size": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" + "type": "integer", + "examples": [ + 108 + ] }, "default_branch": { - "type": "string" + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] }, "open_issues_count": { - "type": "integer" + "type": "integer", + "examples": [ + 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", + "examples": [ + true + ] }, "topics": { "type": "array", @@ -132203,30 +125845,61 @@ } }, "has_issues": { - "type": "boolean" + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_projects": { - "type": "boolean" + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_wiki": { - "type": "boolean" + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_pages": { "type": "boolean" }, "has_downloads": { - "type": "boolean" + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] }, "has_discussions": { - "type": "boolean" + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] }, "archived": { + "description": "Whether the repository is archived.", + "default": false, "type": "boolean" }, "disabled": { - "type": "boolean" + "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": { @@ -132259,238 +125932,136 @@ "2011-01-26T19:14:43Z" ] }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", "examples": [ - "admin" + true ] }, "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", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# 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", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true ] }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - } + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] }, - "forks": { - "type": "integer", + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", "examples": [ - 0 + false ] }, - "open_issues": { - "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", "examples": [ - 0 + false ] }, - "watchers": { - "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 + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", "examples": [ - 0 + true ] }, "allow_forking": { + "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { - "type": "boolean", + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", "examples": [ - false + "\"2020-07-09T00:17:42Z\"" ] }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], + "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": { - "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": [ @@ -132539,580 +126110,89 @@ "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" ] } - ] - }, - "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" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "packages", - "subcategory": "packages" - } - }, - "delete": { - "summary": "Delete a package for an organization", - "description": "Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", - "tags": [ - "packages" - ], - "operationId": "packages/delete-package-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization" - }, - "parameters": [ - { - "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 (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", - "in": "path", - "required": true, - "schema": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - } - }, - { - "name": "package_name", - "description": "The name of the package.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "404": { - "description": "Resource not found", - "content": { - "application/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" - } - } - } - } - } - }, - "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}/packages/{package_type}/{package_name}/restore": { - "post": { - "summary": "Restore a package for an organization", - "description": "Restores an entire package in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", - "tags": [ - "packages" - ], - "operationId": "packages/restore-package-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization" - }, - "parameters": [ - { - "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 (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", - "in": "path", - "required": true, - "schema": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - } - }, - { - "name": "package_name", - "description": "The name of the package.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "token", - "description": "package token", - "schema": { - "type": "string" - }, - "required": false, - "in": "query" - } - ], - "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" - } - } - } - } - } - }, - "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}/packages/{package_type}/{package_name}/versions": { - "get": { - "summary": "List package versions for a package owned by an organization", - "description": "Lists package versions for a package owned by an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", - "tags": [ - "packages" - ], - "operationId": "packages/get-all-package-versions-for-package-owned-by-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization" - }, - "parameters": [ - { - "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 (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", - "in": "path", - "required": true, - "schema": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - } - }, - { - "name": "package_name", - "description": "The name of the package.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "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": 30 - } - }, - { - "name": "state", - "in": "query", - "required": false, - "description": "The state of the package, either active or deleted.", - "schema": { - "type": "string", - "enum": [ - "active", - "deleted" - ], - "default": "active" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Package Version", - "description": "A version of a software package", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the package version.", - "type": "integer", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the package version.", - "type": "string", - "examples": [ - "latest" - ] }, "url": { "type": "string", + "format": "uri", "examples": [ - "https://api.github.com/orgs/github/packages/container/super-linter/versions/786068" - ] - }, - "package_html_url": { - "type": "string", - "examples": [ - "https://github.com/orgs/github/packages/container/package/super-linter" - ] - }, - "html_url": { - "type": "string", - "examples": [ - "https://github.com/orgs/github/packages/container/super-linter/786068" - ] - }, - "license": { - "type": "string", - "examples": [ - "MIT" + "https://api.github.com/orgs/octo-org/migrations/79" ] }, - "description": { - "type": "string" - }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2011-04-10T20:09:31Z" + "2015-07-06T15:33:38-07:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2014-03-03T18:58:10Z" + "2015-07-06T15:33:38-07:00" ] }, - "deleted_at": { + "node_id": { + "type": "string" + }, + "archive_url": { "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] + "format": "uri" }, - "metadata": { - "type": "object", - "title": "Package Version Metadata", - "properties": { - "package_type": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ], - "examples": [ - "docker" - ] - }, - "container": { - "type": "object", - "title": "Container Metadata", - "properties": { - "tags": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "tags" - ] - }, - "docker": { - "type": "object", - "title": "Docker Metadata", - "properties": { - "tag": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "tags" - ] - } - }, - "required": [ - "package_type" - ] + "exclude": { + "description": "Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `\"repositories\"`.", + "type": "array", + "items": { + "description": "Allowed values that can be passed to the exclude parameter. The array can include any of: `\"repositories\"`.", + "type": "string" + } } }, "required": [ "id", - "name", + "node_id", + "owner", + "guid", + "state", + "lock_repositories", + "exclude_metadata", + "exclude_git_data", + "exclude_attachments", + "exclude_releases", + "exclude_owner_projects", + "org_metadata_only", + "repositories", "url", - "package_html_url", "created_at", "updated_at" ] @@ -133122,109 +126202,173 @@ "default": { "value": [ { - "id": 245301, - "name": "1.0.4", - "url": "https://api.github.com/orgs/octo-org/packages/npm/hello-world-npm/versions/245301", - "package_html_url": "https://github.com/octo-org/hello-world-npm/packages/43752", - "created_at": "2019-11-05T22:49:04Z", - "updated_at": "2019-11-05T22:49:04Z", - "html_url": "https://github.com/octo-org/hello-world-npm/packages/43752?version=1.0.4", - "metadata": { - "package_type": "npm" - } - }, - { - "id": 209672, - "name": "1.0.3", - "url": "https://api.github.com/orgs/octo-org/packages/npm/hello-world-npm/versions/209672", - "package_html_url": "https://github.com/octo-org/hello-world-npm/packages/43752", - "created_at": "2019-10-29T15:42:11Z", - "updated_at": "2019-10-29T15:42:12Z", - "html_url": "https://github.com/octo-org/hello-world-npm/packages/43752?version=1.0.3", - "metadata": { - "package_type": "npm" - } + "id": 79, + "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 + }, + "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "state": "pending", + "lock_repositories": true, + "exclude_attachments": false, + "exclude_releases": false, + "exclude_owner_projects": false, + "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://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + ], + "url": "https://api.github.com/orgs/octo-org/migrations/79", + "created_at": "2015-07-06T15:33:38-07:00", + "updated_at": "2015-07-06T15:33:38-07:00", + "node_id": "MDQ6VXNlcjE=" } ] } } } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/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" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "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" } } } @@ -133233,50 +126377,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "category": "packages", - "subcategory": "packages" + "category": "migrations", + "subcategory": "orgs" } - } - }, - "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}": { - "get": { - "summary": "Get a package version for an organization", - "description": "Gets a specific package version in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + }, + "post": { + "summary": "Start an organization migration", + "description": "Initiates the generation of a migration archive.", "tags": [ - "packages" + "migrations" ], - "operationId": "packages/get-package-version-for-organization", + "operationId": "migrations/start-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization" + "url": "https://docs.github.com/rest/migrations/orgs#start-an-organization-migration" }, "parameters": [ - { - "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 (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", - "in": "path", - "required": true, - "schema": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - } - }, - { - "name": "package_name", - "description": "The name of the package.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, { "name": "org", "description": "The organization name. The name is not case sensitive.", @@ -133285,1446 +126401,1504 @@ "schema": { "type": "string" } - }, - { - "name": "package_version_id", - "description": "Unique identifier of the package version.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "repositories": { + "type": "array", + "description": "A list of arrays indicating which repositories should be migrated.", + "items": { + "type": "string" + } + }, + "lock_repositories": { + "type": "boolean", + "description": "Indicates whether repositories should be locked (to prevent manipulation) while migrating data.", + "default": false, + "examples": [ + true + ] + }, + "exclude_metadata": { + "type": "boolean", + "description": "Indicates whether metadata should be excluded and only git source should be included for the migration.", + "default": false + }, + "exclude_git_data": { + "type": "boolean", + "description": "Indicates whether the repository git data should be excluded from the migration.", + "default": false + }, + "exclude_attachments": { + "type": "boolean", + "description": "Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).", + "default": false, + "examples": [ + true + ] + }, + "exclude_releases": { + "type": "boolean", + "description": "Indicates whether releases should be excluded from the migration (to reduce migration archive file size).", + "default": false, + "examples": [ + true + ] + }, + "exclude_owner_projects": { + "type": "boolean", + "description": "Indicates whether projects owned by the organization or users should be excluded. from the migration.", + "default": false, + "examples": [ + true + ] + }, + "org_metadata_only": { + "type": "boolean", + "description": "Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).", + "default": false, + "examples": [ + true + ] + }, + "exclude": { + "type": "array", + "description": "Exclude related items from being returned in the response in order to improve performance of the request.", + "items": { + "type": "string", + "enum": [ + "repositories" + ] + } + } + }, + "required": [ + "repositories" + ] + }, + "examples": { + "default": { + "value": { + "repositories": [ + "github/Hello-World" + ], + "lock_repositories": true + } + } + } + } + } + }, "responses": { - "200": { + "201": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Package Version", - "description": "A version of a software package", + "title": "Migration", + "description": "A migration.", "type": "object", "properties": { "id": { - "description": "Unique identifier of the package version.", "type": "integer", + "format": "int64", "examples": [ - 1 + 79 ] }, - "name": { - "description": "The name of the package version.", - "type": "string", - "examples": [ - "latest" + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } ] }, - "url": { + "guid": { "type": "string", "examples": [ - "https://api.github.com/orgs/github/packages/container/super-linter/versions/786068" + "0b989ba4-242f-11e5-81e1-c7b6966d2516" ] }, - "package_html_url": { + "state": { "type": "string", "examples": [ - "https://github.com/orgs/github/packages/container/package/super-linter" + "pending" ] }, - "html_url": { - "type": "string", + "lock_repositories": { + "type": "boolean", "examples": [ - "https://github.com/orgs/github/packages/container/super-linter/786068" + true ] }, - "license": { - "type": "string", - "examples": [ - "MIT" - ] + "exclude_metadata": { + "type": "boolean" }, - "description": { - "type": "string" + "exclude_git_data": { + "type": "boolean" }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] + "exclude_attachments": { + "type": "boolean" }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] + "exclude_releases": { + "type": "boolean" }, - "deleted_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] + "exclude_owner_projects": { + "type": "boolean" }, - "metadata": { - "type": "object", - "title": "Package Version Metadata", - "properties": { - "package_type": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ], - "examples": [ - "docker" - ] - }, - "container": { - "type": "object", - "title": "Container Metadata", - "properties": { - "tags": { - "type": "array", - "items": { - "type": "string" + "org_metadata_only": { + "type": "boolean" + }, + "repositories": { + "type": "array", + "description": "The repositories included in the migration. Only returned for export migrations.", + "items": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] } - } + ] }, - "required": [ - "tags" - ] - }, - "docker": { - "type": "object", - "title": "Docker Metadata", - "properties": { - "tag": { - "type": "array", - "items": { - "type": "string" + "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" + ] }, - "required": [ - "tags" - ] - } - }, - "required": [ - "package_type" - ] - } - }, - "required": [ - "id", - "name", - "url", - "package_html_url", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 836, - "name": "sha256:b3d3e366b55f9a54599220198b3db5da8f53592acbbb7dc7e4e9878762fc5344", - "url": "https://api.github.com/orgs/github/packages/container/hello_docker/versions/836", - "package_html_url": "https://github.com/orgs/github/packages/container/package/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/hello_docker/836", - "metadata": { - "package_type": "container", - "container": { - "tags": [ - "latest" - ] - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "packages", - "subcategory": "packages" - } - }, - "delete": { - "summary": "Delete package version for an organization", - "description": "Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", - "tags": [ - "packages" - ], - "operationId": "packages/delete-package-version-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization" - }, - "parameters": [ - { - "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 (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", - "in": "path", - "required": true, - "schema": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - } - }, - { - "name": "package_name", - "description": "The name of the package.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "package_version_id", - "description": "Unique identifier of the package version.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "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" - } - } - } - } - } - }, - "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}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { - "post": { - "summary": "Restore package version for an organization", - "description": "Restores a specific package version in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", - "tags": [ - "packages" - ], - "operationId": "packages/restore-package-version-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization" - }, - "parameters": [ - { - "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 (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", - "in": "path", - "required": true, - "schema": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - } - }, - { - "name": "package_name", - "description": "The name of the package.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "package_version_id", - "description": "Unique identifier of the package version.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "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" - } - } - } - } - } - }, - "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}/personal-access-token-requests": { - "get": { - "summary": "List requests to access organization resources with fine-grained personal access tokens", - "description": "Lists requests from organization members to access organization resources with a fine-grained personal access token.\n\nOnly GitHub Apps can use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/list-pat-grant-requests", - "externalDocs": { - "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": [ - { - "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": "sort", - "description": "The property by which to sort the results.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created_at" - ], - "default": "created_at" - } - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "owner", - "description": "A list of owner usernames to use to filter the results.", - "in": "query", - "required": false, - "schema": { - "type": "array", - "maxItems": 10, - "items": { - "type": "string" - }, - "examples": [ - "owner[]=octocat1,owner[]=octocat2" - ] - } - }, - { - "name": "repository", - "description": "The name of the repository to use to filter the results.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "examples": [ - "Hello-World" - ] - } - }, - { - "name": "permission", - "description": "The permission to use to filter the results.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "examples": [ - "issues_read" - ] - } - }, - { - "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) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "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) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "token_id", - "description": "The ID of the token", - "in": "query", - "required": false, - "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "examples": [ - "token_id[]=1,token_id[]=2" - ] - } - } - ], - "responses": { - "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" - } - } - } - } - } - }, - "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": [ - { + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { "type": [ "string", "null" ] }, - { + "email": { "type": [ - "integer", + "string", "null" ] }, - { + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { "type": [ - "array", + "string", "null" ], - "items": { - "type": "string" - } + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] - } - } - } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/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" - } - } - } - } - } - }, - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Simple Organization Programmatic Access Grant Request", - "description": "Minimal representation of an organization programmatic access grant request for enumerations", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the request for access via fine-grained personal access token. The `pat_request_id` used to review PAT requests." - }, - "reason": { - "type": [ - "string", - "null" - ], - "description": "Reason for requesting access." - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" ] }, - "email": { + "description": { "type": [ "string", "null" + ], + "examples": [ + "This your first repo!" ] }, - "login": { + "fork": { + "type": "boolean" + }, + "url": { "type": "string", + "format": "uri", "examples": [ - "octocat" + "https://api.github.com/repos/octocat/Hello-World" ] }, - "id": { - "type": "integer", - "format": "int64", + "archive_url": { + "type": "string", "examples": [ - 1 + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, - "node_id": { + "assignees_url": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, - "avatar_url": { + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, - "gravatar_id": { - "type": [ - "string", - "null" - ], + "deployments_url": { + "type": "string", + "format": "uri", "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, - "url": { + "downloads_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, - "html_url": { + "events_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat" + "http://api.github.com/repos/octocat/Hello-World/events" ] }, - "followers_url": { + "forks_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "http://api.github.com/repos/octocat/Hello-World/forks" ] }, - "following_url": { + "git_commits_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, - "gists_url": { + "git_refs_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, - "starred_url": { + "git_tags_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, - "subscriptions_url": { + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "http://api.github.com/repos/octocat/Hello-World/languages" ] }, - "organizations_url": { + "merges_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "http://api.github.com/repos/octocat/Hello-World/merges" ] }, - "repos_url": { + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, - "events_url": { + "statuses_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, - "received_events_url": { + "subscribers_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, - "type": { + "subscription_url": { "type": "string", + "format": "uri", "examples": [ - "User" + "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, - "site_admin": { - "type": "boolean" + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] }, - "starred_at": { + "teams_url": { "type": "string", + "format": "uri", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "http://api.github.com/repos/octocat/Hello-World/teams" ] }, - "user_view_type": { + "trees_url": { "type": "string", "examples": [ - "public" + "http://api.github.com/repos/octocat/Hello-World/git/trees{/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" - ] - }, - "repository_selection": { - "type": "string", - "enum": [ - "none", - "all", - "subset" - ], - "description": "Type of repository selection requested." - }, - "repositories_url": { - "type": "string", - "description": "URL to the list of repositories requested to be accessed via fine-grained personal access token. Should only be followed when `repository_selection` is `subset`." - }, - "permissions": { - "type": "object", - "description": "Permissions requested, categorized by type of permission.", - "properties": { - "organization": { - "type": "object", - "additionalProperties": { - "type": "string" - } }, - "repository": { - "type": "object", - "additionalProperties": { - "type": "string" - } + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] }, - "other": { - "type": "object", - "additionalProperties": { + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { "type": "string" } - } - } - }, - "created_at": { - "type": "string", - "description": "Date and time when the request for access was created." - }, - "token_id": { - "type": "integer", - "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." - }, - "token_name": { - "type": "string", - "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." - }, - "token_expired": { - "type": "boolean", - "description": "Whether the associated fine-grained personal access token has expired." - }, - "token_expires_at": { - "type": [ - "string", - "null" - ], - "description": "Date and time when the associated fine-grained personal access token expires." - }, - "token_last_used_at": { - "type": [ - "string", - "null" - ], - "description": "Date and time when the associated fine-grained personal access token was last used for authentication." - } - }, - "required": [ - "id", - "reason", - "owner", - "repository_selection", - "repositories_url", - "permissions", - "created_at", - "token_id", - "token_name", - "token_expired", - "token_expires_at", - "token_last_used_at" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 25381, - "reason": "I need to access the GitHub API", - "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_selection": "all", - "repositories_url": "https://api.github.com/organizations/652551/personal-access-token-requests/25381/repositories", - "permissions": { - "organization": { - "members": "read" }, - "repository": { - "metadata": "read" - } - }, - "created_at": "2023-05-16T08:47:09.000-07:00", - "token_id": 98716, - "token_name": "Some Token", - "token_expired": false, - "token_expires_at": "2023-11-16T08:47:09.000-07:00", - "token_last_used_at": null - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "personal-access-tokens" - } - }, - "post": { - "summary": "Review requests to access organization resources with fine-grained personal access tokens", - "description": "Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token.\n\nOnly GitHub Apps can use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/review-pat-grant-requests-in-bulk", - "externalDocs": { - "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": [ - { - "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": { - "pat_request_ids": { - "type": "array", - "description": "Unique identifiers of the requests for access via fine-grained personal access token. Must be formed of between 1 and 100 `pat_request_id` values.", - "items": { - "type": "integer" - }, - "minItems": 1, - "maxItems": 100 - }, - "action": { - "type": "string", - "description": "Action to apply to the requests.", - "enum": [ - "approve", - "deny" - ] - }, - "reason": { - "type": [ - "string", - "null" - ], - "description": "Reason for approving or denying the requests. Max 1024 characters.", - "maxLength": 1024 - } - }, - "required": [ - "action" - ] - }, - "examples": { - "204": { - "summary": "Example of denying a request", - "value": { - "pat_request_ids": [ - 42, - 73 - ], - "action": "deny", - "reason": "Access is too broad." - } - } - } - } - } - }, - "responses": { - "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" - } - } - } - } - } - }, - "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" + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, - "field": { - "type": "string" + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, - "message": { + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", "type": "string" }, - "code": { + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { "type": "string" }, - "index": { + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { "type": "integer" }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } + "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" + ] } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" }, "url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octo-org/migrations/79" + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2015-07-06T15:33:38-07:00" + ] }, - "documentation_url": { - "type": "string" + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2015-07-06T15:33:38-07:00" + ] }, - "url": { + "node_id": { "type": "string" }, - "status": { - "type": "string" + "archive_url": { + "type": "string", + "format": "uri" + }, + "exclude": { + "description": "Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `\"repositories\"`.", + "type": "array", + "items": { + "description": "Allowed values that can be passed to the exclude parameter. The array can include any of: `\"repositories\"`.", + "type": "string" + } } - } - } - } - } - }, - "202": { - "description": "Accepted", - "content": { - "application/json": { - "schema": { - "type": "object" + }, + "required": [ + "id", + "node_id", + "owner", + "guid", + "state", + "lock_repositories", + "exclude_metadata", + "exclude_git_data", + "exclude_attachments", + "exclude_releases", + "exclude_owner_projects", + "org_metadata_only", + "repositories", + "url", + "created_at", + "updated_at" + ] }, "examples": { "default": { - "value": null + "value": { + "id": 79, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "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 + }, + "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "state": "pending", + "lock_repositories": true, + "exclude_attachments": false, + "exclude_releases": false, + "exclude_owner_projects": false, + "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://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + ], + "url": "https://api.github.com/orgs/octo-org/migrations/79", + "created_at": "2015-07-06T15:33:38-07:00", + "updated_at": "2015-07-06T15:33:38-07:00" + } } } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "personal-access-tokens" - } - } - }, - "/orgs/{org}/personal-access-token-requests/{pat_request_id}": { - "post": { - "summary": "Review a request to access organization resources with a fine-grained personal access token", - "description": "Approves or denies a pending request to access organization resources via a fine-grained personal access token.\n\nOnly GitHub Apps can use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/review-pat-grant-request", - "externalDocs": { - "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": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } }, - { - "name": "pat_request_id", - "in": "path", - "description": "Unique identifier of the request for access via fine-grained personal access token.", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "action": { - "type": "string", - "description": "Action to apply to the request.", - "enum": [ - "approve", - "deny" - ] - }, - "reason": { - "type": [ - "string", - "null" - ], - "description": "Reason for approving or denying the request. Max 1024 characters.", - "maxLength": 1024 - } - }, - "required": [ - "action" - ] - }, - "examples": { - "204": { - "summary": "Example of denying a request", - "value": { - "action": "deny", - "reason": "This request is denied because the access is too broad." - } - } - } - } - } - }, - "responses": { - "500": { - "description": "Internal Error", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -134823,82 +127997,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" - } - } - } - } - } - }, - "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" - } - } - } - } - } - }, - "204": { - "description": "A header with no content is returned." } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "personal-access-tokens" + "enabledForGitHubApps": false, + "category": "migrations", + "subcategory": "orgs" } } }, - "/orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories": { + "/orgs/{org}/migrations/{migration_id}": { "get": { - "summary": "List repositories requested to be accessed by a fine-grained personal access token", - "description": "Lists the repositories a fine-grained personal access token request is requesting access to.\n\nOnly GitHub Apps can use this endpoint.", + "summary": "Get an organization migration status", + "description": "Fetches the status of a migration.\n\nThe `state` of a migration can be one of the following values:\n\n* `pending`, which means the migration hasn't started yet.\n* `exporting`, which means the migration is in progress.\n* `exported`, which means the migration finished successfully.\n* `failed`, which means the migration failed.", "tags": [ - "orgs" + "migrations" ], - "operationId": "orgs/list-pat-grant-request-repositories", + "operationId": "migrations/get-status-for-org", "externalDocs": { "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" + "url": "https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status" }, "parameters": [ { @@ -134911,69 +128030,1515 @@ } }, { - "name": "pat_request_id", + "name": "migration_id", + "description": "The unique identifier of the migration.", "in": "path", - "description": "Unique identifier of the request for access via fine-grained personal access token.", "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).\"", + "name": "exclude", + "description": "Exclude attributes from the API response to improve performance", "in": "query", "schema": { - "type": "integer", - "default": 1 + "type": "array", + "items": { + "description": "Allowed values that can be passed to the exclude param.", + "enum": [ + "repositories" + ], + "type": "string", + "examples": [ + "repositories" + ] + } } } ], "responses": { - "500": { - "description": "Internal Error", + "200": { + "description": "* `pending`, which means the migration hasn't started yet.\n* `exporting`, which means the migration is in progress.\n* `exported`, which means the migration finished successfully.\n* `failed`, which means the migration failed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Migration", + "description": "A migration.", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 79 + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "guid": { + "type": "string", + "examples": [ + "0b989ba4-242f-11e5-81e1-c7b6966d2516" + ] + }, + "state": { + "type": "string", + "examples": [ + "pending" + ] + }, + "lock_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "exclude_metadata": { + "type": "boolean" + }, + "exclude_git_data": { + "type": "boolean" + }, + "exclude_attachments": { + "type": "boolean" + }, + "exclude_releases": { + "type": "boolean" + }, + "exclude_owner_projects": { + "type": "boolean" + }, + "org_metadata_only": { + "type": "boolean" + }, + "repositories": { + "type": "array", + "description": "The repositories included in the migration. Only returned for export migrations.", + "items": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + } + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octo-org/migrations/79" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2015-07-06T15:33:38-07:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2015-07-06T15:33:38-07:00" + ] + }, + "node_id": { + "type": "string" + }, + "archive_url": { + "type": "string", + "format": "uri" + }, + "exclude": { + "description": "Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `\"repositories\"`.", + "type": "array", + "items": { + "description": "Allowed values that can be passed to the exclude parameter. The array can include any of: `\"repositories\"`.", + "type": "string" + } + } + }, + "required": [ + "id", + "node_id", + "owner", + "guid", + "state", + "lock_repositories", + "exclude_metadata", + "exclude_git_data", + "exclude_attachments", + "exclude_releases", + "exclude_owner_projects", + "org_metadata_only", + "repositories", + "url", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 79, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "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 + }, + "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "state": "exported", + "lock_repositories": true, + "exclude_attachments": false, + "exclude_releases": false, + "exclude_owner_projects": false, + "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://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + ], + "url": "https://api.github.com/orgs/octo-org/migrations/79", + "created_at": "2015-07-06T15:33:38-07:00", + "updated_at": "2015-07-06T15:33:38-07:00" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/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": "migrations", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/migrations/{migration_id}/archive": { + "get": { + "summary": "Download an organization migration archive", + "description": "Fetches the URL to a migration archive.", + "tags": [ + "migrations" + ], + "operationId": "migrations/download-archive-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "migration_id", + "description": "The unique identifier of the migration.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "302": { + "description": "Response" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { "message": { "type": "string" }, @@ -134990,9 +129555,132 @@ } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "migrations", + "subcategory": "orgs" + } + }, + "delete": { + "summary": "Delete an organization migration archive", + "description": "Deletes a previous migration archive. Migration archives are automatically deleted after seven days.", + "tags": [ + "migrations" + ], + "operationId": "migrations/delete-archive-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "403": { - "description": "Forbidden", + { + "name": "migration_id", + "description": "The unique identifier of the migration.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "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": false, + "category": "migrations", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock": { + "delete": { + "summary": "Unlock an organization repository", + "description": "Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data.", + "tags": [ + "migrations" + ], + "operationId": "migrations/unlock-repo-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "migration_id", + "description": "The unique identifier of the migration.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "repo_name", + "description": "repo_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -135016,7 +129704,67 @@ } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "migrations", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/migrations/{migration_id}/repositories": { + "get": { + "summary": "List repositories in an organization migration", + "description": "List all the repositories for this organization migration.", + "tags": [ + "migrations" + ], + "operationId": "migrations/list-repos-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "migration_id", + "description": "The unique identifier of the migration.", + "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": { @@ -136012,27 +130760,53 @@ } } } + }, + "404": { + "description": "Resource not found", + "content": { + "application/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": "personal-access-tokens" + "enabledForGitHubApps": false, + "category": "migrations", + "subcategory": "orgs" } } }, - "/orgs/{org}/personal-access-tokens": { + "/orgs/{org}/organization-roles": { "get": { - "summary": "List fine-grained personal access tokens with access to organization resources", - "description": "Lists approved fine-grained personal access tokens owned by organization members that can access organization resources.\n\nOnly GitHub Apps can use this endpoint.", + "summary": "Get all organization roles for an organization", + "description": "Lists the organization roles available in this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], - "operationId": "orgs/list-pat-grants", + "operationId": "orgs/list-org-roles", "externalDocs": { "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" + "url": "https://docs.github.com/rest/orgs/organization-roles#get-all-organization-roles-for-an-organization" }, "parameters": [ { @@ -136043,701 +130817,346 @@ "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": "sort", - "description": "The property by which to sort the results.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created_at" - ], - "default": "created_at" - } - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "owner", - "description": "A list of owner usernames to use to filter the results.", - "in": "query", - "required": false, - "schema": { - "type": "array", - "maxItems": 10, - "items": { - "type": "string" - }, - "examples": [ - "owner[]=octocat1,owner[]=octocat2" - ] - } - }, - { - "name": "repository", - "description": "The name of the repository to use to filter the results.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "examples": [ - "Hello-World" - ] - } - }, - { - "name": "permission", - "description": "The permission to use to filter the results.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "examples": [ - "issues_read" - ] - } - }, - { - "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) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "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) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "token_id", - "description": "The ID of the token", - "in": "query", - "required": false, - "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "examples": [ - "token_id[]=1,token_id[]=2" - ] - } } ], "responses": { - "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" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + "200": { + "description": "Response - list of organization roles", "content": { "application/json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + "total_count": { + "type": "integer", + "description": "The total number of organization roles available to the organization." }, - "errors": { + "roles": { "type": "array", + "description": "The list of organization roles available to the organization.", "items": { + "title": "Organization Role", + "description": "Organization roles", "type": "object", - "required": [ - "code" - ], "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" + "id": { + "description": "The unique identifier of the role.", + "type": "integer", + "format": "int64" }, - "code": { + "name": { + "description": "The name of the role.", "type": "string" }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "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" - } - } - } - } - } - }, - "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" - } - } - } - } - } - }, - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Organization Programmatic Access Grant", - "description": "Minimal representation of an organization programmatic access grant for enumerations", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the fine-grained personal access token grant. The `pat_id` used to get details about an approved fine-grained personal access token." - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { + "description": { + "description": "A short description about who this role is for or what permissions it grants.", "type": [ "string", "null" ] }, - "email": { + "base_role": { "type": [ "string", "null" + ], + "description": "The system role from which this role inherits permissions.", + "enum": [ + "read", + "triage", + "write", + "maintain", + "admin", + null ] }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { + "source": { "type": [ "string", "null" ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" + "description": "Source answers the question, \"where did this role come from?\"", + "enum": [ + "Organization", + "Enterprise", + "Predefined", + null ] }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] + "permissions": { + "description": "A list of permissions included in this role.", + "type": "array", + "items": { + "type": "string" + } }, - "type": { - "type": "string", - "examples": [ - "User" + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { + "created_at": { + "description": "The date and time the role was created.", "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "format": "date-time" }, - "user_view_type": { + "updated_at": { + "description": "The date and time the role was last updated.", "type": "string", - "examples": [ - "public" - ] + "format": "date-time" } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "name", + "permissions", + "organization", + "created_at", + "updated_at" ] - }, - "repository_selection": { - "type": "string", - "enum": [ - "none", - "all", - "subset" - ], - "description": "Type of repository selection requested." - }, - "repositories_url": { - "type": "string", - "description": "URL to the list of repositories the fine-grained personal access token can access. Only follow when `repository_selection` is `subset`." - }, - "permissions": { - "type": "object", - "description": "Permissions requested, categorized by type of permission.", - "properties": { - "organization": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "repository": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "other": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, - "access_granted_at": { - "type": "string", - "description": "Date and time when the fine-grained personal access token was approved to access the organization." - }, - "token_id": { - "type": "integer", - "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." - }, - "token_name": { - "type": "string", - "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." - }, - "token_expired": { - "type": "boolean", - "description": "Whether the associated fine-grained personal access token has expired." - }, - "token_expires_at": { - "type": [ - "string", - "null" - ], - "description": "Date and time when the associated fine-grained personal access token expires." - }, - "token_last_used_at": { - "type": [ - "string", - "null" - ], - "description": "Date and time when the associated fine-grained personal access token was last used for authentication." } - }, - "required": [ - "id", - "owner", - "repository_selection", - "repositories_url", - "permissions", - "access_granted_at", - "token_id", - "token_name", - "token_expired", - "token_expires_at", - "token_last_used_at" - ] + } } }, "examples": { "default": { - "value": [ - { - "id": 25381, - "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_selection": "all", - "repositories_url": "https://api.github.com/organizations/652551/personal-access-tokens/25381/repositories", - "permissions": { + "value": { + "total_count": 2, + "roles": [ + { + "id": 8030, + "name": "Custom Role Manager", + "description": "Permissions to manage custom roles within an org", + "permissions": [ + "write_organization_custom_repo_role", + "write_organization_custom_org_role", + "read_organization_custom_repo_role", + "read_organization_custom_org_role" + ], "organization": { - "members": "read" + "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 }, - "repository": { - "metadata": "read" - } + "created_at": "2022-07-04T22:19:11Z", + "updated_at": "2022-07-04T22:20:11Z" }, - "access_granted_at": "2023-05-16T08:47:09.000-07:00", - "token_id": 98716, - "token_name": "Some Token", - "token_expired": false, - "token_expires_at": "2023-11-16T08:47:09.000-07:00", - "token_last_used_at": null - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "personal-access-tokens" - } - }, - "post": { - "summary": "Update the access to organization resources via fine-grained personal access tokens", - "description": "Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access.\n\nOnly GitHub Apps can use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/update-pat-accesses", - "externalDocs": { - "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": [ - { - "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": { - "action": { - "type": "string", - "description": "Action to apply to the fine-grained personal access token.", - "enum": [ - "revoke" - ] - }, - "pat_ids": { - "description": "The IDs of the fine-grained personal access tokens.", - "type": "array", - "items": { - "type": "integer", - "description": "Unique identifier of the fine-grained personal access token." - }, - "minItems": 1, - "maxItems": 100 - } - }, - "required": [ - "action", - "pat_ids" - ] - }, - "examples": { - "204": { - "summary": "Example of revoking a fine-grained personal access token.", - "value": { - "action": "revoke", - "pat_ids": [ - 1296269, - 1296280 - ] - } - } - } - } - } - }, - "responses": { - "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" + { + "id": 8031, + "name": "Auditor", + "description": "Permissions to read the organization audit log", + "permissions": [ + "read_audit_logs" + ], + "organization": { + "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 + }, + "created_at": "2022-07-04T22:19:11Z", + "updated_at": "2022-07-04T22:20:11Z" + } + ] } } } @@ -136770,47 +131189,6 @@ } } }, - "202": { - "description": "Accepted", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "default": { - "value": null - } - } - } - } - }, - "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" - } - } - } - } - } - }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { @@ -136891,21 +131269,21 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", - "subcategory": "personal-access-tokens" + "subcategory": "organization-roles" } } }, - "/orgs/{org}/personal-access-tokens/{pat_id}": { - "post": { - "summary": "Update the access a fine-grained personal access token has to organization resources", - "description": "Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access.\n\nOnly GitHub Apps can use this endpoint.", + "/orgs/{org}/organization-roles/teams/{team_slug}": { + "delete": { + "summary": "Remove all organization roles for a team", + "description": "Removes all assigned organization roles from a team. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], - "operationId": "orgs/update-pat-access", + "operationId": "orgs/revoke-all-org-roles-team", "externalDocs": { "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" + "url": "https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team" }, "parameters": [ { @@ -136918,8 +131296,62 @@ } }, { - "name": "pat_id", - "description": "The unique identifier of the fine-grained personal access token.", + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + } + } + }, + "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}": { + "put": { + "summary": "Assign an organization role to a team", + "description": "Assigns an organization role to a team in an organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/assign-team-to-org-role", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-team" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "role_id", + "description": "The unique identifier of the role.", "in": "path", "required": true, "schema": { @@ -136927,94 +131359,558 @@ } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "action": { - "type": "string", - "description": "Action to apply to the fine-grained personal access token.", - "enum": [ - "revoke" - ] - } - }, - "required": [ - "action" - ] - }, - "examples": { - "204": { - "summary": "Example of revoking a fine-grained personal access token.", - "value": { - "action": "revoke" - } - } - } + "responses": { + "204": { + "description": "Response" + }, + "404": { + "description": "Response if the organization, team or role does not exist." + }, + "422": { + "description": "Response if the organization roles feature is not enabled for the organization, or validation failed." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + } + }, + "delete": { + "summary": "Remove an organization role from a team", + "description": "Removes an organization role from a team. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-org-role-team", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-team" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "role_id", + "description": "The unique identifier of the role.", + "in": "path", + "required": true, + "schema": { + "type": "integer" } } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + } + } + }, + "/orgs/{org}/organization-roles/users/{username}": { + "delete": { + "summary": "Remove all organization roles for a user", + "description": "Revokes all assigned organization roles from a user. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-all-org-roles-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-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" + } + } + ], "responses": { - "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" - } - } - } - } + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + } + } + }, + "/orgs/{org}/organization-roles/users/{username}/{role_id}": { + "put": { + "summary": "Assign an organization role to a user", + "description": "Assigns an organization role to a member of an organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/assign-user-to-org-role", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-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": "role_id", + "description": "The unique identifier of the role.", + "in": "path", + "required": true, + "schema": { + "type": "integer" } + } + ], + "responses": { + "204": { + "description": "Response" }, "404": { - "description": "Resource not found", + "description": "Response if the organization, user or role does not exist." + }, + "422": { + "description": "Response if the organization roles feature is not enabled enabled for the organization, the validation failed, or the user is not an organization member." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + } + }, + "delete": { + "summary": "Remove an organization role from a user", + "description": "Remove an organization role from a user. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-org-role-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-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": "role_id", + "description": "The unique identifier of the role.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + } + } + }, + "/orgs/{org}/organization-roles/{role_id}": { + "get": { + "summary": "Get an organization role", + "description": "Gets an organization role that is available to this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/get-org-role", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "role_id", + "description": "The unique identifier of the role.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Organization Role", + "description": "Organization roles", "type": "object", "properties": { - "message": { - "type": "string" + "id": { + "description": "The unique identifier of the role.", + "type": "integer", + "format": "int64" }, - "documentation_url": { + "name": { + "description": "The name of the role.", "type": "string" }, - "url": { - "type": "string" + "description": { + "description": "A short description about who this role is for or what permissions it grants.", + "type": [ + "string", + "null" + ] }, - "status": { - "type": "string" + "base_role": { + "type": [ + "string", + "null" + ], + "description": "The system role from which this role inherits permissions.", + "enum": [ + "read", + "triage", + "write", + "maintain", + "admin", + null + ] + }, + "source": { + "type": [ + "string", + "null" + ], + "description": "Source answers the question, \"where did this role come from?\"", + "enum": [ + "Organization", + "Enterprise", + "Predefined", + null + ] + }, + "permissions": { + "description": "A list of permissions included in this role.", + "type": "array", + "items": { + "type": "string" + } + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "created_at": { + "description": "The date and time the role was created.", + "type": "string", + "format": "date-time" + }, + "updated_at": { + "description": "The date and time the role was last updated.", + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "name", + "permissions", + "organization", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 8030, + "name": "Custom Role Manager", + "description": "Permissions to manage custom roles within an org", + "permissions": [ + "write_organization_custom_repo_role", + "write_organization_custom_org_role", + "read_organization_custom_repo_role", + "read_organization_custom_org_role" + ], + "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" } } } } } }, - "204": { - "description": "A header with no content is returned." - }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -137119,21 +132015,21 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", - "subcategory": "personal-access-tokens" + "subcategory": "organization-roles" } } }, - "/orgs/{org}/personal-access-tokens/{pat_id}/repositories": { + "/orgs/{org}/organization-roles/{role_id}/teams": { "get": { - "summary": "List repositories a fine-grained personal access token has access to", - "description": "Lists the repositories a fine-grained personal access token has access to.\n\nOnly GitHub Apps can use this endpoint.", + "summary": "List teams that are assigned to an organization role", + "description": "Lists the teams that are assigned to an organization role. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, you must be an administrator for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], - "operationId": "orgs/list-pat-grant-repositories", + "operationId": "orgs/list-org-role-teams", "externalDocs": { "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" + "url": "https://docs.github.com/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role" }, "parameters": [ { @@ -137146,9 +132042,9 @@ } }, { - "name": "pat_id", + "name": "role_id", + "description": "The unique identifier of the role.", "in": "path", - "description": "Unique identifier of the fine-grained personal access token.", "required": true, "schema": { "type": "integer" @@ -137174,941 +132070,916 @@ } ], "responses": { - "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" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/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" - } - } - } - } - } - }, "200": { - "description": "Response", + "description": "Response - List of assigned teams", "content": { "application/json": { "schema": { "type": "array", + "description": "List of teams assigned to the organization role", "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", + "title": "A Role Assignment for a Team", + "description": "The Relationship a Team has with a role.", "type": "object", "properties": { - "id": { - "type": "integer", - "format": "int64", + "assignment": { + "type": "string", + "description": "Determines if the team has a direct, indirect, or mixed relationship to a role", + "enum": [ + "direct", + "indirect", + "mixed" + ], "examples": [ - 1296269 + "direct" ] }, + "id": { + "type": "integer" + }, "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] + "type": "string" }, "name": { - "type": "string", - "examples": [ - "Hello-World" - ] + "type": "string" }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" ] }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] + "pull": { + "type": "boolean" }, - "type": { - "type": "string", - "examples": [ - "User" - ] + "triage": { + "type": "boolean" }, - "site_admin": { + "push": { "type": "boolean" }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "maintain": { + "type": "boolean" }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] + "admin": { + "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" + "pull", + "triage", + "push", + "maintain", + "admin" ] }, - "private": { - "type": "boolean" + "url": { + "type": "string", + "format": "uri" }, "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat/Hello-World" + "https://github.com/orgs/rails/teams/core" ] }, - "description": { + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "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" + } + } + } + }, + "404": { + "description": "Response if the organization or role does not exist." + }, + "422": { + "description": "Response if the organization roles feature is not enabled or validation failed." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + } + } + }, + "/orgs/{org}/organization-roles/{role_id}/users": { + "get": { + "summary": "List users that are assigned to an organization role", + "description": "Lists organization members that are assigned to an organization role. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, you must be an administrator for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-org-role-users", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "role_id", + "description": "The unique identifier of the role.", + "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 - List of assigned users", + "content": { + "application/json": { + "schema": { + "type": "array", + "description": "List of users assigned to the organization role", + "items": { + "title": "A Role Assignment for a User", + "description": "The Relationship a User has with a role.", + "type": "object", + "properties": { + "assignment": { + "type": "string", + "description": "Determines if the user has a direct, indirect, or mixed relationship to a role", + "enum": [ + "direct", + "indirect", + "mixed" + ], + "examples": [ + "direct" + ] + }, + "inherited_from": { + "description": "Team the user has gotten the role through", + "type": "array", + "items": { + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + }, + "name": { "type": [ "string", "null" - ], - "examples": [ - "This your first repo!" ] }, - "fork": { - "type": "boolean" + "email": { + "type": [ + "string", + "null" + ] }, - "url": { + "login": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World" + "octocat" ] }, - "archive_url": { - "type": "string", + "id": { + "type": "integer", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + 1 ] }, - "assignees_url": { + "node_id": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + "MDQ6VXNlcjE=" ] }, - "blobs_url": { + "avatar_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + "https://github.com/images/error/octocat_happy.gif" ] }, - "branches_url": { - "type": "string", + "gravatar_id": { + "type": [ + "string", + "null" + ], "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + "41d064eb2195891e12d0413f63227ea7" ] }, - "collaborators_url": { + "url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + "https://api.github.com/users/octocat" ] }, - "comments_url": { + "html_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + "https://github.com/octocat" ] }, - "commits_url": { + "followers_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "https://api.github.com/users/octocat/followers" ] }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { + "following_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "contributors_url": { + "gists_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "deployments_url": { + "starred_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "downloads_url": { + "subscriptions_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" + "https://api.github.com/users/octocat/subscriptions" ] }, - "events_url": { + "organizations_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" + "https://api.github.com/users/octocat/orgs" ] }, - "forks_url": { + "repos_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" + "https://api.github.com/users/octocat/repos" ] }, - "git_commits_url": { + "events_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "git_refs_url": { + "received_events_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + "https://api.github.com/users/octocat/received_events" ] }, - "git_tags_url": { + "type": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + "User" ] }, - "git_url": { - "type": "string" + "site_admin": { + "type": "boolean" }, - "issue_comment_url": { + "starred_at": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + "\"2020-07-09T00:17:55Z\"" ] }, - "issue_events_url": { + "user_view_type": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "404": { + "description": "Response if the organization or role does not exist." + }, + "422": { + "description": "Response if the organization roles feature is not enabled or validation failed." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + } + } + }, + "/orgs/{org}/outside_collaborators": { + "get": { + "summary": "List outside collaborators for an organization", + "description": "List all users who are outside collaborators of an organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-outside-collaborators", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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) enabled will be returned. `2fa_insecure` means that only outside collaborators 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.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "2fa_disabled", + "2fa_insecure", + "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", + "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": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" ] }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + "email": { + "type": [ + "string", + "null" ] }, - "keys_url": { + "login": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + "octocat" ] }, - "labels_url": { - "type": "string", + "id": { + "type": "integer", + "format": "int64", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + 1 ] }, - "languages_url": { + "node_id": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" + "MDQ6VXNlcjE=" ] }, - "merges_url": { + "avatar_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" + "https://github.com/images/error/octocat_happy.gif" ] }, - "milestones_url": { - "type": "string", + "gravatar_id": { + "type": [ + "string", + "null" + ], "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + "41d064eb2195891e12d0413f63227ea7" ] }, - "notifications_url": { + "url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + "https://api.github.com/users/octocat" ] }, - "pulls_url": { + "html_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + "https://github.com/octocat" ] }, - "releases_url": { + "followers_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + "https://api.github.com/users/octocat/followers" ] }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { + "following_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "statuses_url": { + "gists_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "subscribers_url": { + "starred_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "subscription_url": { + "subscriptions_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" + "https://api.github.com/users/octocat/subscriptions" ] }, - "tags_url": { + "organizations_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" + "https://api.github.com/users/octocat/orgs" ] }, - "teams_url": { + "repos_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" + "https://api.github.com/users/octocat/repos" ] }, - "trees_url": { + "events_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "hooks_url": { + "received_events_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" + "https://api.github.com/users/octocat/received_events" ] }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { + "type": { "type": "string", "examples": [ - "admin" + "User" ] }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { + "site_admin": { "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", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# 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", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", + "starred_at": { + "type": "string", "examples": [ - 0 + "\"2020-07-09T00:17:55Z\"" ] }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", + "user_view_type": { + "type": "string", "examples": [ - false + "public" ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "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", + "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" ] } @@ -138117,122 +132988,24 @@ "default": { "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}", - "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": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "has_discussions": false, - "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 - }, - "security_and_analysis": { - "advanced_security": { - "status": "enabled" - }, - "secret_scanning": { - "status": "enabled" - }, - "secret_scanning_push_protection": { - "status": "disabled" - }, - "secret_scanning_non_provider_patterns": { - "status": "disabled" - } - } + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false } ] } @@ -138253,21 +133026,21 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", - "subcategory": "personal-access-tokens" + "subcategory": "outside-collaborators" } } }, - "/orgs/{org}/private-registries": { - "get": { - "summary": "List private registries for an organization", - "description": "\nLists all private registry configurations 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.", + "/orgs/{org}/outside_collaborators/{username}": { + "put": { + "summary": "Convert an organization member to outside collaborator", + "description": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"[Converting an organization member to an outside collaborator](https://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)\". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"", "tags": [ - "private-registries" + "orgs" ], - "operationId": "private-registries/list-org-private-registries", + "operationId": "orgs/convert-member-to-outside-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/private-registries/organization-configurations#list-private-registries-for-an-organization" + "url": "https://docs.github.com/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator" }, "parameters": [ { @@ -138280,258 +133053,8 @@ } }, { - "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", - "configurations" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "configurations": { - "type": "array", - "items": { - "title": "Organization private registry", - "description": "Private registry configuration for an organization", - "type": "object", - "properties": { - "name": { - "description": "The name of the private registry configuration.", - "type": "string", - "examples": [ - "MAVEN_REPOSITORY_SECRET" - ] - }, - "registry_type": { - "description": "The registry type.", - "enum": [ - "maven_repository", - "nuget_feed", - "goproxy_server", - "npm_registry", - "rubygems_server", - "cargo_registry", - "composer_repository", - "docker_registry", - "git_source", - "helm_registry", - "hex_organization", - "hex_repository", - "pub_repository", - "python_index", - "terraform_registry" - ], - "type": "string" - }, - "username": { - "description": "The username to use when authenticating with the private registry.", - "type": [ - "string", - "null" - ], - "examples": [ - "monalisa" - ] - }, - "visibility": { - "description": "Which type of organization repositories have access to the private registry.", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "name", - "registry_type", - "visibility", - "created_at", - "updated_at" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 1, - "configurations": [ - { - "name": "MAVEN_REPOSITORY_SECRET", - "registry_type": "maven_repository", - "username": "monalisa", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "selected" - } - ] - } - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "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", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "schemas": { - "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": "private-registries", - "subcategory": "organization-configurations" - } - }, - "post": { - "summary": "Create a private registry for an organization", - "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [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": [ - "private-registries" - ], - "operationId": "private-registries/create-org-private-registry", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/private-registries/organization-configurations#create-a-private-registry-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", + "name": "username", + "description": "The handle for the GitHub user account.", "in": "path", "required": true, "schema": { @@ -138540,552 +133063,57 @@ } ], "requestBody": { - "required": true, + "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { - "registry_type": { - "description": "The registry type.", - "type": "string", - "enum": [ - "maven_repository", - "nuget_feed", - "goproxy_server", - "npm_registry", - "rubygems_server", - "cargo_registry", - "composer_repository", - "docker_registry", - "git_source", - "helm_registry", - "hex_organization", - "hex_repository", - "pub_repository", - "python_index", - "terraform_registry" - ] - }, - "url": { - "description": "The URL of the private registry.", - "type": "string", - "format": "uri" - }, - "username": { - "description": "The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication.", - "type": [ - "string", - "null" - ] - }, - "encrypted_value": { - "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 private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint.", - "type": "string", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - }, - "key_id": { - "description": "The ID of the key you used to encrypt the secret.", - "type": "string" - }, - "visibility": { - "description": "Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry.", - "type": "string", - "enum": [ - "all", - "private", - "selected" - ] - }, - "selected_repository_ids": { - "description": "An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. You can manage the list of selected repositories using the [Update a private registry for an organization](https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) endpoint. This field should be omitted if `visibility` is set to `all` or `private`.", - "type": "array", - "items": { - "type": "integer" - } + "async": { + "type": "boolean", + "description": "When set to `true`, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.", + "default": false } - }, - "required": [ - "registry_type", - "url", - "encrypted_value", - "key_id", - "visibility" - ] + } }, "examples": { - "org-private-registry-with-private-visibility": { - "summary": "Example of a private registry configuration with private visibility", - "value": { - "registry_type": "maven_repository", - "url": "https://maven.pkg.github.com/organization/", - "username": "monalisa", - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678", - "visibility": "private" - } - }, - "org-private-registry-with-selected-visibility": { - "summary": "Example of a private registry configuration with selected visibility", + "202": { + "summary": "Status code 202, asynchronous request", "value": { - "registry_type": "maven_repository", - "url": "https://maven.pkg.github.com/organization/", - "username": "monalisa", - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678", - "visibility": "selected", - "selected_repository_ids": [ - 1296269, - 1296280 - ] + "async": true } - } - } - } - } - }, - "responses": { - "201": { - "description": "The organization private registry configuration", - "content": { - "application/json": { - "schema": { - "title": "Organization private registry", - "description": "Private registry configuration for an organization", - "type": "object", - "properties": { - "name": { - "description": "The name of the private registry configuration.", - "type": "string", - "examples": [ - "MAVEN_REPOSITORY_SECRET" - ] - }, - "registry_type": { - "description": "The registry type.", - "enum": [ - "maven_repository", - "nuget_feed", - "goproxy_server", - "npm_registry", - "rubygems_server", - "cargo_registry", - "composer_repository", - "docker_registry", - "git_source", - "helm_registry", - "hex_organization", - "hex_repository", - "pub_repository", - "python_index", - "terraform_registry" - ], - "type": "string" - }, - "username": { - "description": "The username to use when authenticating with the private registry.", - "type": "string", - "examples": [ - "monalisa" - ] - }, - "visibility": { - "description": "Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry.", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" - }, - "selected_repository_ids": { - "type": "array", - "description": "An array of repository IDs that can access the organization private registry when `visibility` is set to `selected`.", - "items": { - "type": "integer" - } - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "name", - "registry_type", - "visibility", - "created_at", - "updated_at" - ] }, - "examples": { - "org-private-registry-with-selected-visibility": { - "value": { - "name": "MAVEN_REPOSITORY_SECRET", - "registry_type": "maven_repository", - "username": "monalisa", - "visibility": "private", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z" - } - }, - "org-private-registry-with-private-visibility": { - "value": { - "name": "MAVEN_REPOSITORY_SECRET", - "registry_type": "maven_repository", - "username": "monalisa", - "visibility": "selected", - "selected_repository_ids": [ - 1296269, - 1296280 - ], - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } + "204": { + "summary": "Status code 204, synchronous request", + "value": null } } } } }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "private-registries", - "subcategory": "organization-configurations" - } - } - }, - "/orgs/{org}/private-registries/public-key": { - "get": { - "summary": "Get private registries public key for an organization", - "description": "\nGets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "private-registries" - ], - "operationId": "private-registries/get-org-public-key", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-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", + "202": { + "description": "User is getting converted asynchronously", "content": { "application/json": { "schema": { "type": "object", - "required": [ - "key_id", - "key" - ], - "properties": { - "key_id": { - "description": "The identifier for the key.", - "type": "string", - "examples": [ - "012345678912345678" - ] - }, - "key": { - "description": "The Base64 encoded public key.", - "type": "string", - "examples": [ - "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" - ] - } - } + "properties": {}, + "additionalProperties": false }, "examples": { - "default": { - "value": { - "key_id": "012345678912345678", - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" - } + "202": { + "value": null } } } - }, - "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": "private-registries", - "subcategory": "organization-configurations" - } - } - }, - "/orgs/{org}/private-registries/{secret_name}": { - "get": { - "summary": "Get a private registry for an organization", - "description": "\nGet the configuration of a single private registry defined for an organization, omitting its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "private-registries" - ], - "operationId": "private-registries/get-org-private-registry", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-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": "User was converted" }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The specified private registry configuration for the organization", - "content": { - "application/json": { - "schema": { - "title": "Organization private registry", - "description": "Private registry configuration for an organization", - "type": "object", - "properties": { - "name": { - "description": "The name of the private registry configuration.", - "type": "string", - "examples": [ - "MAVEN_REPOSITORY_SECRET" - ] - }, - "registry_type": { - "description": "The registry type.", - "enum": [ - "maven_repository", - "nuget_feed", - "goproxy_server", - "npm_registry", - "rubygems_server", - "cargo_registry", - "composer_repository", - "docker_registry", - "git_source", - "helm_registry", - "hex_organization", - "hex_repository", - "pub_repository", - "python_index", - "terraform_registry" - ], - "type": "string" - }, - "username": { - "description": "The username to use when authenticating with the private registry.", - "type": [ - "string", - "null" - ], - "examples": [ - "monalisa" - ] - }, - "visibility": { - "description": "Which type of organization repositories have access to the private registry.", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "name", - "registry_type", - "visibility", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "name": "MAVEN_REPOSITORY_SECRET", - "registry_type": "maven_repository", - "username": "monalisa", - "visibility": "private", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z" - } - } - } - } - } + "403": { + "description": "Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"" }, "404": { "description": "Resource not found", @@ -139117,20 +133145,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "private-registries", - "subcategory": "organization-configurations" + "category": "orgs", + "subcategory": "outside-collaborators" } }, - "patch": { - "summary": "Update a private registry for an organization", - "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [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.", + "delete": { + "summary": "Remove outside collaborator from an organization", + "description": "Removing a user from this list will remove them from all the organization's repositories.", "tags": [ - "private-registries" + "orgs" ], - "operationId": "private-registries/update-org-private-registry", + "operationId": "orgs/remove-outside-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization" + "url": "https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization" }, "parameters": [ { @@ -139143,8 +133171,8 @@ } }, { - "name": "secret_name", - "description": "The name of the secret.", + "name": "username", + "description": "The handle for the GitHub user account.", "in": "path", "required": true, "schema": { @@ -139152,96 +133180,15 @@ } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "registry_type": { - "description": "The registry type.", - "type": "string", - "enum": [ - "maven_repository", - "nuget_feed", - "goproxy_server", - "npm_registry", - "rubygems_server", - "cargo_registry", - "composer_repository", - "docker_registry", - "git_source", - "helm_registry", - "hex_organization", - "hex_repository", - "pub_repository", - "python_index", - "terraform_registry" - ] - }, - "url": { - "description": "The URL of the private registry.", - "type": "string", - "format": "uri" - }, - "username": { - "description": "The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication.", - "type": [ - "string", - "null" - ] - }, - "encrypted_value": { - "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 private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint.", - "type": "string", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - }, - "key_id": { - "description": "The ID of the key you used to encrypt the secret.", - "type": "string" - }, - "visibility": { - "description": "Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry.", - "type": "string", - "enum": [ - "all", - "private", - "selected" - ] - }, - "selected_repository_ids": { - "description": "An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. This field should be omitted if `visibility` is set to `all` or `private`.", - "type": "array", - "items": { - "type": "integer" - } - } - } - }, - "examples": { - "default": { - "value": { - "username": "monalisa", - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678" - } - } - } - } - } - }, "responses": { "204": { "description": "Response" }, - "404": { - "description": "Resource not found", + "422": { + "description": "Unprocessable Entity if user is a member of the organization", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", "properties": { "message": { @@ -139249,87 +133196,14 @@ }, "documentation_url": { "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" } } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } + }, + "examples": { + "response-if-user-is-a-member-of-the-organization": { + "value": { + "message": "You cannot specify an organization member to remove as an outside collaborator.", + "documentation_url": "https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization" } } } @@ -139340,161 +133214,41 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "private-registries", - "subcategory": "organization-configurations" + "category": "orgs", + "subcategory": "outside-collaborators" } - }, - "delete": { - "summary": "Delete a private registry for an organization", - "description": "\nDelete a private registry configuration at the organization-level.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + } + }, + "/orgs/{org}/packages": { + "get": { + "summary": "List packages for an organization", + "description": "Lists packages in an organization readable by the user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ - "private-registries" + "packages" ], - "operationId": "private-registries/delete-org-private-registry", + "operationId": "packages/list-packages-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization" + "url": "https://docs.github.com/rest/packages/packages#list-packages-for-an-organization" }, "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", + "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 (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "query", "required": true, "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "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" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": [ - "string", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } + "type": "string", + "enum": [ + "npm", + "maven", + "rubygems", + "docker", + "nuget", + "container" + ] } }, - "404": { - "description": "Resource not found", - "content": { - "application/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": "private-registries", - "subcategory": "organization-configurations" - } - } - }, - "/orgs/{org}/projects": { - "get": { - "summary": "List organization projects", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/list-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#list-organization-projects" - }, - "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", @@ -139505,36 +133259,35 @@ } }, { - "name": "state", - "description": "Indicates the state of the projects to return.", + "name": "visibility", + "description": "The selected visibility of the packages. This parameter is optional and only filters an existing result set.\n\nThe `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`.\nFor the list of GitHub Packages registries that support granular permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"", "in": "query", "required": false, "schema": { "type": "string", "enum": [ - "open", - "closed", - "all" - ], - "default": "open" + "public", + "private", + "internal" + ] } }, { - "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": "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": 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/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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", - "default": 1 + "default": 30 } } ], @@ -139546,81 +133299,68 @@ "schema": { "type": "array", "items": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", + "title": "Package", + "description": "A software package", "type": "object", "properties": { - "owner_url": { - "type": "string", - "format": "uri", + "id": { + "description": "Unique identifier of the package.", + "type": "integer", "examples": [ - "https://api.github.com/repos/api-playground/projects-test" + 1 ] }, - "url": { + "name": { + "description": "The name of the package.", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/projects/1002604" + "super-linter" ] }, - "html_url": { + "package_type": { "type": "string", - "format": "uri", + "enum": [ + "npm", + "maven", + "rubygems", + "docker", + "nuget", + "container" + ], "examples": [ - "https://github.com/api-playground/projects-test/projects/12" + "docker" ] }, - "columns_url": { + "url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/projects/1002604/columns" + "https://api.github.com/orgs/github/packages/container/super-linter" ] }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", + "html_url": { "type": "string", "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" + "https://github.com/orgs/github/packages/container/package/super-linter" ] }, - "number": { + "version_count": { + "description": "The number of versions of the package.", "type": "integer", "examples": [ 1 ] }, - "state": { - "description": "State of the project; either 'open' or 'closed'", + "visibility": { "type": "string", + "enum": [ + "private", + "public" + ], "examples": [ - "open" + "private" ] }, - "creator": { + "owner": { "anyOf": [ { "type": "null" @@ -139795,47 +133535,884 @@ } ] }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" + "repository": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "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", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# 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", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "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" + ] + } ] }, - "updated_at": { + "created_at": { "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] + "format": "date-time" }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "updated_at": { "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" + "format": "date-time" } }, "required": [ "id", - "node_id", - "number", "name", - "body", - "state", + "package_type", + "visibility", "url", "html_url", - "owner_url", - "creator", - "columns_url", + "version_count", "created_at", "updated_at" ] @@ -139845,67 +134422,107 @@ "default": { "value": [ { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "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/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", + "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 }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": true + "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" } ] } } } - }, - "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" + } + } } } } }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + "401": { + "description": "Requires authentication", "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" @@ -139913,40 +134530,68 @@ "documentation_url": { "type": "string" }, - "errors": { - "type": "array", - "items": { - "type": "string" - } + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } + }, + "400": { + "description": "The value of `per_page` multiplied by `page` cannot be greater than 10000." } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "post": { - "summary": "Create an organization project", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" + } + } + }, + "/orgs/{org}/packages/{package_type}/{package_name}": { + "get": { + "summary": "Get a package for an organization", + "description": "Gets a specific package in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ - "projects-classic" + "packages" ], - "operationId": "projects-classic/create-for-org", + "operationId": "packages/get-package-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#create-an-organization-project" + "url": "https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization" }, "parameters": [ + { + "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 (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "npm", + "maven", + "rubygems", + "docker", + "nuget", + "container" + ] + } + }, + { + "name": "package_name", + "description": "The name of the package.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "org", "description": "The organization name. The name is not case sensitive.", @@ -139957,118 +134602,74 @@ } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the project." - }, - "body": { - "type": "string", - "description": "The description of the project." - } - }, - "required": [ - "name" - ] - }, - "examples": { - "default": { - "value": { - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year." - } - } - } - } - } - }, "responses": { - "201": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", + "title": "Package", + "description": "A software package", "type": "object", "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", + "id": { + "description": "Unique identifier of the package.", + "type": "integer", "examples": [ - "https://api.github.com/projects/1002604" + 1 ] }, - "html_url": { + "name": { + "description": "The name of the package.", "type": "string", - "format": "uri", "examples": [ - "https://github.com/api-playground/projects-test/projects/12" + "super-linter" ] }, - "columns_url": { + "package_type": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", + "enum": [ + "npm", + "maven", + "rubygems", + "docker", + "nuget", + "container" + ], "examples": [ - 1002604 + "docker" ] }, - "node_id": { + "url": { "type": "string", "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" + "https://api.github.com/orgs/github/packages/container/super-linter" ] }, - "name": { - "description": "Name of the project", + "html_url": { "type": "string", "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" + "https://github.com/orgs/github/packages/container/package/super-linter" ] }, - "number": { + "version_count": { + "description": "The number of versions of the package.", "type": "integer", "examples": [ 1 ] }, - "state": { - "description": "State of the project; either 'open' or 'closed'", + "visibility": { "type": "string", + "enum": [ + "private", + "public" + ], "examples": [ - "open" + "private" ] }, - "creator": { + "owner": { "anyOf": [ { "type": "null" @@ -140243,830 +134844,920 @@ } ] }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "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 - }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z" - } - } - } - } - } - }, - "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" - } - } - } - } - } - }, - "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 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": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/orgs/{org}/properties/schema": { - "get": { - "summary": "Get all custom properties for an organization", - "description": "Gets all custom properties defined for an organization.\nOrganization members can read these properties.", - "tags": [ - "orgs" - ], - "operationId": "orgs/get-all-custom-properties", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/custom-properties#get-all-custom-properties-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": "array", - "items": { - "title": "Organization Custom Property", - "description": "Custom property defined on an organization", - "type": "object", - "properties": { - "property_name": { - "type": "string", - "description": "The name of the property" - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL that can be used to fetch, update, or delete info about this property via the API." - }, - "source_type": { - "type": "string", - "description": "The source type of the property", - "enum": [ - "organization", - "enterprise" - ], - "examples": [ - "organization" - ] - }, - "value_type": { - "type": "string", - "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ], - "description": "The type of the value for the property", - "examples": [ - "single_select" - ] - }, - "required": { - "type": "boolean", - "description": "Whether the property is required." - }, - "default_value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "Default value of the property", - "type": [ - "null", - "string", - "array" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "Short description of the property" - }, - "allowed_values": { - "type": [ - "array", - "null" - ], - "items": { - "type": "string", - "maxLength": 75 - }, - "maxItems": 200, - "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." - }, - "values_editable_by": { - "type": [ - "string", - "null" - ], - "enum": [ - "org_actors", - "org_and_repo_actors", - null - ], - "description": "Who can edit the values of the property", - "examples": [ - "org_actors" - ] - } - }, - "required": [ - "property_name", - "value_type" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "property_name": "environment", - "url": "https://api.github.com/orgs/github/properties/schema/environment", - "source_type": "organization", - "value_type": "single_select", - "required": true, - "default_value": "production", - "description": "Prod or dev environment", - "allowed_values": [ - "production", - "development" - ], - "values_editable_by": "org_actors" - }, - { - "property_name": "service", - "url": "https://api.github.com/orgs/github/properties/schema/service", - "source_type": "organization", - "value_type": "string" - }, - { - "property_name": "team", - "url": "https://api.github.com/orgs/github/properties/schema/team", - "source_type": "organization", - "value_type": "string", - "description": "Team owning the repository" - } - ] - } - } - } - } - }, - "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": "custom-properties" - } - }, - "patch": { - "summary": "Create or update custom properties for an organization", - "description": "Creates new or updates existing custom properties defined for an organization in a batch.\n\nIf the property already exists, the existing property will be replaced with the new values.\nMissing optional values will fall back to default values, previous values will be overwritten.\nE.g. if a property exists with `values_editable_by: org_and_repo_actors` and it's updated without specifying `values_editable_by`, it will be updated to default value `org_actors`.\n\nTo use this endpoint, the authenticated user must be one of:\n - An administrator for the organization.\n - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.", - "tags": [ - "orgs" - ], - "operationId": "orgs/create-or-update-custom-properties", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-properties-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": { - "properties": { - "type": "array", - "description": "The array of custom properties to create or update.", - "items": { - "title": "Organization Custom Property", - "description": "Custom property defined on an organization", - "type": "object", - "properties": { - "property_name": { - "type": "string", - "description": "The name of the property" - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL that can be used to fetch, update, or delete info about this property via the API." - }, - "source_type": { - "type": "string", - "description": "The source type of the property", - "enum": [ - "organization", - "enterprise" - ], - "examples": [ - "organization" - ] - }, - "value_type": { - "type": "string", - "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ], - "description": "The type of the value for the property", - "examples": [ - "single_select" - ] - }, - "required": { - "type": "boolean", - "description": "Whether the property is required." + "repository": { + "anyOf": [ + { + "type": "null" }, - "default_value": { - "oneOf": [ - { - "type": "string" + { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "Default value of the property", - "type": [ - "null", - "string", - "array" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "Short description of the property" - }, - "allowed_values": { - "type": [ - "array", - "null" - ], - "items": { - "type": "string", - "maxLength": 75 - }, - "maxItems": 200, - "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." - }, - "values_editable_by": { - "type": [ - "string", - "null" - ], - "enum": [ - "org_actors", - "org_and_repo_actors", - null - ], - "description": "Who can edit the values of the property", - "examples": [ - "org_actors" - ] - } - }, - "required": [ - "property_name", - "value_type" - ] - }, - "minItems": 1, - "maxItems": 100 - } - }, - "required": [ - "properties" - ] - }, - "examples": { - "default": { - "value": { - "properties": [ - { - "property_name": "environment", - "value_type": "single_select", - "required": true, - "default_value": "production", - "description": "Prod or dev environment", - "allowed_values": [ - "production", - "development" - ], - "values_editable_by": "org_actors" - }, - { - "property_name": "service", - "value_type": "string" - }, - { - "property_name": "team", - "value_type": "string", - "description": "Team owning the repository" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Organization Custom Property", - "description": "Custom property defined on an organization", - "type": "object", - "properties": { - "property_name": { - "type": "string", - "description": "The name of the property" - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL that can be used to fetch, update, or delete info about this property via the API." - }, - "source_type": { - "type": "string", - "description": "The source type of the property", - "enum": [ - "organization", - "enterprise" - ], - "examples": [ - "organization" - ] - }, - "value_type": { - "type": "string", - "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ], - "description": "The type of the value for the property", - "examples": [ - "single_select" - ] - }, - "required": { - "type": "boolean", - "description": "Whether the property is required." - }, - "default_value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "Default value of the property", - "type": [ - "null", - "string", - "array" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "Short description of the property" - }, - "allowed_values": { - "type": [ - "array", - "null" - ], - "items": { - "type": "string", - "maxLength": 75 - }, - "maxItems": 200, - "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." - }, - "values_editable_by": { - "type": [ - "string", - "null" - ], - "enum": [ - "org_actors", - "org_and_repo_actors", - null - ], - "description": "Who can edit the values of the property", - "examples": [ - "org_actors" - ] - } - }, - "required": [ - "property_name", - "value_type" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "property_name": "environment", - "url": "https://api.github.com/orgs/github/properties/schema/environment", - "source_type": "organization", - "value_type": "single_select", - "required": true, - "default_value": "production", - "description": "Prod or dev environment", - "allowed_values": [ - "production", - "development" - ], - "values_editable_by": "org_actors" - }, - { - "property_name": "service", - "url": "https://api.github.com/orgs/github/properties/schema/service", - "source_type": "organization", - "value_type": "string" - }, - { - "property_name": "team", - "url": "https://api.github.com/orgs/github/properties/schema/team", - "source_type": "organization", - "value_type": "string", - "description": "Team owning the repository" - } - ] - } - } - } - } - }, - "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" + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "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", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# 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", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "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" + ] + } + ] }, - "url": { - "type": "string" + "created_at": { + "type": "string", + "format": "date-time" }, - "status": { - "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": { + "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" } } } @@ -141076,28 +135767,43 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "custom-properties" + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" } - } - }, - "/orgs/{org}/properties/schema/{custom_property_name}": { - "get": { - "summary": "Get a custom property for an organization", - "description": "Gets a custom property that is defined for an organization.\nOrganization members can read these properties.", + }, + "delete": { + "summary": "Delete a package for an organization", + "description": "Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ - "orgs" + "packages" ], - "operationId": "orgs/get-custom-property", + "operationId": "packages/delete-package-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization" + "url": "https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization" }, "parameters": [ { - "name": "org", - "description": "The organization name. The name is not case sensitive.", + "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 (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "npm", + "maven", + "rubygems", + "docker", + "nuget", + "container" + ] + } + }, + { + "name": "package_name", + "description": "The name of the package.", "in": "path", "required": true, "schema": { @@ -141105,8 +135811,8 @@ } }, { - "name": "custom_property_name", - "description": "The custom property name", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { @@ -141115,125 +135821,29 @@ } ], "responses": { - "200": { - "description": "Response", + "204": { + "description": "Response" + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { - "title": "Organization Custom Property", - "description": "Custom property defined on an organization", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "property_name": { - "type": "string", - "description": "The name of the property" - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL that can be used to fetch, update, or delete info about this property via the API." - }, - "source_type": { - "type": "string", - "description": "The source type of the property", - "enum": [ - "organization", - "enterprise" - ], - "examples": [ - "organization" - ] - }, - "value_type": { - "type": "string", - "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ], - "description": "The type of the value for the property", - "examples": [ - "single_select" - ] - }, - "required": { - "type": "boolean", - "description": "Whether the property is required." - }, - "default_value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "Default value of the property", - "type": [ - "null", - "string", - "array" - ] + "message": { + "type": "string" }, - "description": { - "type": [ - "string", - "null" - ], - "description": "Short description of the property" + "documentation_url": { + "type": "string" }, - "allowed_values": { - "type": [ - "array", - "null" - ], - "items": { - "type": "string", - "maxLength": 75 - }, - "maxItems": 200, - "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + "url": { + "type": "string" }, - "values_editable_by": { - "type": [ - "string", - "null" - ], - "enum": [ - "org_actors", - "org_and_repo_actors", - null - ], - "description": "Who can edit the values of the property", - "examples": [ - "org_actors" - ] - } - }, - "required": [ - "property_name", - "value_type" - ] - }, - "examples": { - "default": { - "value": { - "property_name": "environment", - "url": "https://api.github.com/orgs/github/properties/schema/environment", - "source_type": "organization", - "value_type": "single_select", - "required": true, - "default_value": "production", - "description": "Prod or dev environment", - "allowed_values": [ - "production", - "development" - ] + "status": { + "type": "string" } } } @@ -141266,8 +135876,8 @@ } } }, - "404": { - "description": "Resource not found", + "401": { + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -141295,26 +135905,45 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "custom-properties" + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" } - }, - "put": { - "summary": "Create or update a custom property for an organization", - "description": "Creates a new or updates an existing custom property that is defined for an organization.\n\nTo use this endpoint, the authenticated user must be one of:\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.", + } + }, + "/orgs/{org}/packages/{package_type}/{package_name}/restore": { + "post": { + "summary": "Restore a package for an organization", + "description": "Restores an entire package in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ - "orgs" + "packages" ], - "operationId": "orgs/create-or-update-custom-property", + "operationId": "packages/restore-package-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization" + "url": "https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization" }, "parameters": [ { - "name": "org", - "description": "The organization name. The name is not case sensitive.", + "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 (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "npm", + "maven", + "rubygems", + "docker", + "nuget", + "container" + ] + } + }, + { + "name": "package_name", + "description": "The name of the package.", "in": "path", "required": true, "schema": { @@ -141322,267 +135951,27 @@ } }, { - "name": "custom_property_name", - "description": "The custom property name", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } + }, + { + "name": "token", + "description": "package token", + "schema": { + "type": "string" + }, + "required": false, + "in": "query" } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "title": "Custom Property Set Payload", - "description": "Custom property set payload", - "type": "object", - "properties": { - "value_type": { - "type": "string", - "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ], - "description": "The type of the value for the property", - "examples": [ - "single_select" - ] - }, - "required": { - "type": "boolean", - "description": "Whether the property is required." - }, - "default_value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "Default value of the property", - "type": [ - "null", - "string", - "array" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "Short description of the property" - }, - "allowed_values": { - "type": [ - "array", - "null" - ], - "items": { - "type": "string", - "maxLength": 75 - }, - "maxItems": 200, - "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." - }, - "values_editable_by": { - "type": [ - "string", - "null" - ], - "enum": [ - "org_actors", - "org_and_repo_actors", - null - ], - "description": "Who can edit the values of the property", - "examples": [ - "org_actors" - ] - } - }, - "required": [ - "value_type" - ] - }, - "examples": { - "default": { - "value": { - "value_type": "single_select", - "required": true, - "default_value": "production", - "description": "Prod or dev environment", - "allowed_values": [ - "production", - "development" - ] - } - } - } - } - } - }, "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Organization Custom Property", - "description": "Custom property defined on an organization", - "type": "object", - "properties": { - "property_name": { - "type": "string", - "description": "The name of the property" - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL that can be used to fetch, update, or delete info about this property via the API." - }, - "source_type": { - "type": "string", - "description": "The source type of the property", - "enum": [ - "organization", - "enterprise" - ], - "examples": [ - "organization" - ] - }, - "value_type": { - "type": "string", - "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ], - "description": "The type of the value for the property", - "examples": [ - "single_select" - ] - }, - "required": { - "type": "boolean", - "description": "Whether the property is required." - }, - "default_value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "Default value of the property", - "type": [ - "null", - "string", - "array" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "Short description of the property" - }, - "allowed_values": { - "type": [ - "array", - "null" - ], - "items": { - "type": "string", - "maxLength": 75 - }, - "maxItems": 200, - "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." - }, - "values_editable_by": { - "type": [ - "string", - "null" - ], - "enum": [ - "org_actors", - "org_and_repo_actors", - null - ], - "description": "Who can edit the values of the property", - "examples": [ - "org_actors" - ] - } - }, - "required": [ - "property_name", - "value_type" - ] - }, - "examples": { - "default": { - "value": { - "property_name": "environment", - "url": "https://api.github.com/orgs/github/properties/schema/environment", - "source_type": "organization", - "value_type": "single_select", - "required": true, - "default_value": "production", - "description": "Prod or dev environment", - "allowed_values": [ - "production", - "development" - ] - } - } - } - } - } - }, - "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" - } - } - } - } - } + "204": { + "description": "Response" }, "404": { "description": "Resource not found", @@ -141609,49 +135998,6 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "custom-properties" - } - }, - "delete": { - "summary": "Remove a custom property for an organization", - "description": "Removes a custom property that is defined for an organization.\n\nTo use this endpoint, the authenticated user must be one of:\n - An administrator for the organization.\n - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.", - "tags": [ - "orgs" - ], - "operationId": "orgs/remove-custom-property", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "custom_property_name", - "description": "The custom property name", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "A header with no content is returned." }, "403": { "description": "Forbidden", @@ -141679,8 +136025,8 @@ } } }, - "404": { - "description": "Resource not found", + "401": { + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -141708,25 +136054,51 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "custom-properties" + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" } } }, - "/orgs/{org}/properties/values": { + "/orgs/{org}/packages/{package_type}/{package_name}/versions": { "get": { - "summary": "List custom property values for organization repositories", - "description": "Lists organization repositories with all of their custom property values.\nOrganization members can read these properties.", + "summary": "List package versions for a package owned by an organization", + "description": "Lists package versions for a package owned by an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ - "orgs" + "packages" ], - "operationId": "orgs/list-custom-properties-values-for-repos", + "operationId": "packages/get-all-package-versions-for-package-owned-by-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories" + "url": "https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization" }, "parameters": [ + { + "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 (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "npm", + "maven", + "rubygems", + "docker", + "nuget", + "container" + ] + } + }, + { + "name": "package_name", + "description": "The name of the package.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "org", "description": "The organization name. The name is not case sensitive.", @@ -141737,30 +136109,35 @@ } }, { - "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": "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": 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/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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", - "default": 1 + "default": 30 } }, { - "name": "repository_query", - "description": "Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)\" for a detailed list of qualifiers.", + "name": "state", "in": "query", "required": false, + "description": "The state of the package, either active or deleted.", "schema": { - "type": "string" + "type": "string", + "enum": [ + "active", + "deleted" + ], + "default": "active" } } ], @@ -141772,72 +136149,133 @@ "schema": { "type": "array", "items": { - "title": "Organization Repository Custom Property Values", - "description": "List of custom property values for a repository", + "title": "Package Version", + "description": "A version of a software package", "type": "object", "properties": { - "repository_id": { + "id": { + "description": "Unique identifier of the package version.", "type": "integer", "examples": [ - 1296269 + 1 ] }, - "repository_name": { + "name": { + "description": "The name of the package version.", "type": "string", "examples": [ - "Hello-World" + "latest" ] }, - "repository_full_name": { + "url": { "type": "string", "examples": [ - "octocat/Hello-World" + "https://api.github.com/orgs/github/packages/container/super-linter/versions/786068" ] }, - "properties": { - "type": "array", - "items": { - "title": "Custom Property Value", - "description": "Custom property name and associated value", - "type": "object", - "properties": { - "property_name": { - "type": "string", - "description": "The name of the property" - }, - "value": { - "oneOf": [ - { + "package_html_url": { + "type": "string", + "examples": [ + "https://github.com/orgs/github/packages/container/package/super-linter" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "https://github.com/orgs/github/packages/container/super-linter/786068" + ] + }, + "license": { + "type": "string", + "examples": [ + "MIT" + ] + }, + "description": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "deleted_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "metadata": { + "type": "object", + "title": "Package Version Metadata", + "properties": { + "package_type": { + "type": "string", + "enum": [ + "npm", + "maven", + "rubygems", + "docker", + "nuget", + "container" + ], + "examples": [ + "docker" + ] + }, + "container": { + "type": "object", + "title": "Container Metadata", + "properties": { + "tags": { + "type": "array", + "items": { "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } } - ], - "description": "The value assigned to the property", - "type": [ - "null", - "string", - "array" - ] - } + } + }, + "required": [ + "tags" + ] }, - "required": [ - "property_name", - "value" - ] + "docker": { + "type": "object", + "title": "Docker Metadata", + "properties": { + "tag": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "tags" + ] + } }, - "description": "List of custom property names and associated values" + "required": [ + "package_type" + ] } }, "required": [ - "repository_id", - "repository_name", - "repository_full_name", - "properties" + "id", + "name", + "url", + "package_html_url", + "created_at", + "updated_at" ] } }, @@ -141845,62 +136283,33 @@ "default": { "value": [ { - "repository_id": 1296269, - "repository_name": "Hello-World", - "repository_full_name": "octocat/Hello-World", - "properties": [ - { - "property_name": "environment", - "value": "production" - }, - { - "property_name": "service", - "value": "web" - }, - { - "property_name": "team", - "value": "octocat" - } - ] + "id": 245301, + "name": "1.0.4", + "url": "https://api.github.com/orgs/octo-org/packages/npm/hello-world-npm/versions/245301", + "package_html_url": "https://github.com/octo-org/hello-world-npm/packages/43752", + "created_at": "2019-11-05T22:49:04Z", + "updated_at": "2019-11-05T22:49:04Z", + "html_url": "https://github.com/octo-org/hello-world-npm/packages/43752?version=1.0.4", + "metadata": { + "package_type": "npm" + } + }, + { + "id": 209672, + "name": "1.0.3", + "url": "https://api.github.com/orgs/octo-org/packages/npm/hello-world-npm/versions/209672", + "package_html_url": "https://github.com/octo-org/hello-world-npm/packages/43752", + "created_at": "2019-10-29T15:42:11Z", + "updated_at": "2019-10-29T15:42:12Z", + "html_url": "https://github.com/octo-org/hello-world-npm/packages/43752?version=1.0.3", + "metadata": { + "package_type": "npm" + } } ] } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "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": { @@ -141928,127 +136337,6 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "custom-properties" - } - }, - "patch": { - "summary": "Create or update custom property values for organization repositories", - "description": "Create new or update existing custom property values for repositories in a batch that belong to an organization.\nEach target repository will have its custom property values updated to match the values provided in the request.\n\nA maximum of 30 repositories can be updated in a single request.\n\nUsing a value of `null` for a custom property will remove or 'unset' the property value from the repository.\n\nTo use this endpoint, the authenticated user must be one of:\n - An administrator for the organization.\n - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization.", - "tags": [ - "orgs" - ], - "operationId": "orgs/create-or-update-custom-properties-values-for-repos", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories" - }, - "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": { - "repository_names": { - "type": "array", - "description": "The names of repositories that the custom property values will be applied to.", - "items": { - "type": "string" - }, - "minItems": 1, - "maxItems": 30 - }, - "properties": { - "type": "array", - "description": "List of custom property names and associated values to apply to the repositories.", - "items": { - "title": "Custom Property Value", - "description": "Custom property name and associated value", - "type": "object", - "properties": { - "property_name": { - "type": "string", - "description": "The name of the property" - }, - "value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "The value assigned to the property", - "type": [ - "null", - "string", - "array" - ] - } - }, - "required": [ - "property_name", - "value" - ] - } - } - }, - "required": [ - "repository_names", - "properties" - ] - }, - "examples": { - "default": { - "value": { - "repository_names": [ - "Hello-World", - "octo-repo" - ], - "properties": [ - { - "property_name": "environment", - "value": "production" - }, - { - "property_name": "service", - "value": "web" - }, - { - "property_name": "team", - "value": "octocat" - } - ] - } - } - } - } - } - }, - "responses": { - "204": { - "description": "No Content when custom property values are successfully created or updated" }, "403": { "description": "Forbidden", @@ -142076,8 +136364,8 @@ } } }, - "404": { - "description": "Resource not found", + "401": { + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -142101,107 +136389,49 @@ } } } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "custom-properties" + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" } } }, - "/orgs/{org}/public_members": { + "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}": { "get": { - "summary": "List public organization members", - "description": "Members of an organization can choose to have their membership publicized or not.", + "summary": "Get a package version for an organization", + "description": "Gets a specific package version in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ - "orgs" + "packages" ], - "operationId": "orgs/list-public-members", + "operationId": "packages/get-package-version-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/members#list-public-organization-members" + "url": "https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization" }, "parameters": [ { - "name": "org", - "description": "The organization name. The name is not case sensitive.", + "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 (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "npm", + "maven", + "rubygems", + "docker", + "nuget", + "container" + ] + } + }, + { + "name": "package_name", + "description": "The name of the package.", "in": "path", "required": true, "schema": { @@ -142209,21 +136439,21 @@ } }, { - "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": "package_version_id", + "description": "Unique identifier of the package version.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" } } ], @@ -142233,235 +136463,205 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + "title": "Package Version", + "description": "A version of a software package", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the package version.", + "type": "integer", + "examples": [ + 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" - ] - } + "name": { + "description": "The name of the package version.", + "type": "string", + "examples": [ + "latest" + ] + }, + "url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/packages/container/super-linter/versions/786068" + ] + }, + "package_html_url": { + "type": "string", + "examples": [ + "https://github.com/orgs/github/packages/container/package/super-linter" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "https://github.com/orgs/github/packages/container/super-linter/786068" + ] + }, + "license": { + "type": "string", + "examples": [ + "MIT" + ] + }, + "description": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "deleted_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "metadata": { + "type": "object", + "title": "Package Version Metadata", + "properties": { + "package_type": { + "type": "string", + "enum": [ + "npm", + "maven", + "rubygems", + "docker", + "nuget", + "container" + ], + "examples": [ + "docker" + ] + }, + "container": { + "type": "object", + "title": "Container Metadata", + "properties": { + "tags": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "tags" + ] + }, + "docker": { + "type": "object", + "title": "Docker Metadata", + "properties": { + "tag": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "tags" + ] + } + }, + "required": [ + "package_type" + ] + } + }, + "required": [ + "id", + "name", + "url", + "package_html_url", + "created_at", + "updated_at" + ] }, "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": { + "id": 836, + "name": "sha256:b3d3e366b55f9a54599220198b3db5da8f53592acbbb7dc7e4e9878762fc5344", + "url": "https://api.github.com/orgs/github/packages/container/hello_docker/versions/836", + "package_html_url": "https://github.com/orgs/github/packages/container/package/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/hello_docker/836", + "metadata": { + "package_type": "container", + "container": { + "tags": [ + "latest" + ] + } } - ] + } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } } } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "members" + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" } - } - }, - "/orgs/{org}/public_members/{username}": { - "get": { - "summary": "Check public organization membership for a user", - "description": "Check if the provided user is a public member of the organization.", + }, + "delete": { + "summary": "Delete package version for an organization", + "description": "Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ - "orgs" + "packages" ], - "operationId": "orgs/check-public-membership-for-user", + "operationId": "packages/delete-package-version-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/members#check-public-organization-membership-for-a-user" + "url": "https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization" }, "parameters": [ + { + "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 (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "npm", + "maven", + "rubygems", + "docker", + "nuget", + "container" + ] + } + }, + { + "name": "package_name", + "description": "The name of the package.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "org", "description": "The organization name. The name is not case sensitive.", @@ -142472,42 +136672,145 @@ } }, { - "name": "username", - "description": "The handle for the GitHub user account.", + "name": "package_version_id", + "description": "Unique identifier of the package version.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], "responses": { "204": { - "description": "Response if user is a public member" + "description": "Response" }, "404": { - "description": "Not Found if user is not a public 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" + } + } + } + } + } + }, + "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": true, - "category": "orgs", - "subcategory": "members" + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" } - }, - "put": { - "summary": "Set public organization membership for the authenticated user", - "description": "The user can publicize their own membership. (A user cannot publicize the membership for another user.)\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", + } + }, + "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + "post": { + "summary": "Restore package version for an organization", + "description": "Restores a specific package version in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ - "orgs" + "packages" ], - "operationId": "orgs/set-public-membership-for-authenticated-user", + "operationId": "packages/restore-package-version-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user" + "url": "https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization" }, "parameters": [ + { + "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 (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "npm", + "maven", + "rubygems", + "docker", + "nuget", + "container" + ] + } + }, + { + "name": "package_name", + "description": "The name of the package.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "org", "description": "The organization name. The name is not case sensitive.", @@ -142518,12 +136821,12 @@ } }, { - "name": "username", - "description": "The handle for the GitHub user account.", + "name": "package_version_id", + "description": "Unique identifier of the package version.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], @@ -142531,6 +136834,32 @@ "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" + } + } + } + } + } + }, "403": { "description": "Forbidden", "content": { @@ -142556,25 +136885,53 @@ } } } + }, + "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": "orgs", - "subcategory": "members" + "category": "packages", + "subcategory": "packages" } - }, - "delete": { - "summary": "Remove public organization membership for the authenticated user", - "description": "Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.", + } + }, + "/orgs/{org}/personal-access-token-requests": { + "get": { + "summary": "List requests to access organization resources with fine-grained personal access tokens", + "description": "Lists requests from organization members to access organization resources with a fine-grained personal access token.\n\nOnly GitHub Apps can use this endpoint.", "tags": [ "orgs" ], - "operationId": "orgs/remove-public-membership-for-authenticated-user", + "operationId": "orgs/list-pat-grant-requests", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user" + "url": "https://docs.github.com/rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens" }, "parameters": [ { @@ -142587,8 +136944,635 @@ } }, { - "name": "username", - "description": "The handle for the GitHub user account.", + "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": "sort", + "description": "The property by which to sort the results.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created_at" + ], + "default": "created_at" + } + }, + { + "name": "direction", + "description": "The direction to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "owner", + "description": "A list of owner usernames to use to filter the results.", + "in": "query", + "required": false, + "schema": { + "type": "array", + "maxItems": 10, + "items": { + "type": "string" + }, + "examples": [ + "owner[]=octocat1,owner[]=octocat2" + ] + } + }, + { + "name": "repository", + "description": "The name of the repository to use to filter the results.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "examples": [ + "Hello-World" + ] + } + }, + { + "name": "permission", + "description": "The permission to use to filter the results.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "examples": [ + "issues_read" + ] + } + }, + { + "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) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "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) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "name": "token_id", + "description": "The ID of the token", + "in": "query", + "required": false, + "schema": { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + }, + "examples": [ + "token_id[]=1,token_id[]=2" + ] + } + } + ], + "responses": { + "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" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/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" + } + } + } + } + } + }, + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Simple Organization Programmatic Access Grant Request", + "description": "Minimal representation of an organization programmatic access grant request for enumerations", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the request for access via fine-grained personal access token. The `pat_request_id` used to review PAT requests." + }, + "reason": { + "type": [ + "string", + "null" + ], + "description": "Reason for requesting access." + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "repository_selection": { + "type": "string", + "enum": [ + "none", + "all", + "subset" + ], + "description": "Type of repository selection requested." + }, + "repositories_url": { + "type": "string", + "description": "URL to the list of repositories requested to be accessed via fine-grained personal access token. Should only be followed when `repository_selection` is `subset`." + }, + "permissions": { + "type": "object", + "description": "Permissions requested, categorized by type of permission.", + "properties": { + "organization": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "repository": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "other": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "created_at": { + "type": "string", + "description": "Date and time when the request for access was created." + }, + "token_id": { + "type": "integer", + "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." + }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, + "token_expired": { + "type": "boolean", + "description": "Whether the associated fine-grained personal access token has expired." + }, + "token_expires_at": { + "type": [ + "string", + "null" + ], + "description": "Date and time when the associated fine-grained personal access token expires." + }, + "token_last_used_at": { + "type": [ + "string", + "null" + ], + "description": "Date and time when the associated fine-grained personal access token was last used for authentication." + } + }, + "required": [ + "id", + "reason", + "owner", + "repository_selection", + "repositories_url", + "permissions", + "created_at", + "token_id", + "token_name", + "token_expired", + "token_expires_at", + "token_last_used_at" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 25381, + "reason": "I need to access the GitHub API", + "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_selection": "all", + "repositories_url": "https://api.github.com/organizations/652551/personal-access-token-requests/25381/repositories", + "permissions": { + "organization": { + "members": "read" + }, + "repository": { + "metadata": "read" + } + }, + "created_at": "2023-05-16T08:47:09.000-07:00", + "token_id": 98716, + "token_name": "Some Token", + "token_expired": false, + "token_expires_at": "2023-11-16T08:47:09.000-07:00", + "token_last_used_at": null + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "personal-access-tokens" + } + }, + "post": { + "summary": "Review requests to access organization resources with fine-grained personal access tokens", + "description": "Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token.\n\nOnly GitHub Apps can use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/review-pat-grant-requests-in-bulk", + "externalDocs": { + "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": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { @@ -142596,30 +137580,248 @@ } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "pat_request_ids": { + "type": "array", + "description": "Unique identifiers of the requests for access via fine-grained personal access token. Must be formed of between 1 and 100 `pat_request_id` values.", + "items": { + "type": "integer" + }, + "minItems": 1, + "maxItems": 100 + }, + "action": { + "type": "string", + "description": "Action to apply to the requests.", + "enum": [ + "approve", + "deny" + ] + }, + "reason": { + "type": [ + "string", + "null" + ], + "description": "Reason for approving or denying the requests. Max 1024 characters.", + "maxLength": 1024 + } + }, + "required": [ + "action" + ] + }, + "examples": { + "204": { + "summary": "Example of denying a request", + "value": { + "pat_request_ids": [ + 42, + 73 + ], + "action": "deny", + "reason": "Access is too broad." + } + } + } + } + } + }, "responses": { - "204": { - "description": "Response" + "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" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/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" + } + } + } + } + } + }, + "202": { + "description": "Accepted", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "default": { + "value": null + } + } + } + } } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "orgs", - "subcategory": "members" + "subcategory": "personal-access-tokens" } } }, - "/orgs/{org}/repos": { - "get": { - "summary": "List organization repositories", - "description": "Lists repositories for the specified organization.\n\n> [!NOTE]\n> In order to see the `security_and_analysis` block for a repository 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).\"", + "/orgs/{org}/personal-access-token-requests/{pat_request_id}": { + "post": { + "summary": "Review a request to access organization resources with a fine-grained personal access token", + "description": "Approves or denies a pending request to access organization resources via a fine-grained personal access token.\n\nOnly GitHub Apps can use this endpoint.", "tags": [ - "repos" + "orgs" ], - "operationId": "repos/list-for-org", + "operationId": "orgs/review-pat-grant-request", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/repos#list-organization-repositories" + "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": [ { @@ -142632,50 +137834,250 @@ } }, { - "name": "type", - "description": "Specifies the types of repositories you want returned.", - "in": "query", - "required": false, + "name": "pat_request_id", + "in": "path", + "description": "Unique identifier of the request for access via fine-grained personal access token.", + "required": true, "schema": { - "type": "string", - "enum": [ - "all", - "public", - "private", - "forks", - "sources", - "member" - ], - "default": "all" + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "action": { + "type": "string", + "description": "Action to apply to the request.", + "enum": [ + "approve", + "deny" + ] + }, + "reason": { + "type": [ + "string", + "null" + ], + "description": "Reason for approving or denying the request. Max 1024 characters.", + "maxLength": 1024 + } + }, + "required": [ + "action" + ] + }, + "examples": { + "204": { + "summary": "Example of denying a request", + "value": { + "action": "deny", + "reason": "This request is denied because the access is too broad." + } + } + } + } + } + }, + "responses": { + "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" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/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" + } + } + } + } } }, + "204": { + "description": "A header with no content is returned." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "personal-access-tokens" + } + } + }, + "/orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories": { + "get": { + "summary": "List repositories requested to be accessed by a fine-grained personal access token", + "description": "Lists the repositories a fine-grained personal access token request is requesting access to.\n\nOnly GitHub Apps can use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-pat-grant-request-repositories", + "externalDocs": { + "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": [ { - "name": "sort", - "description": "The property 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": [ - "created", - "updated", - "pushed", - "full_name" - ], - "default": "created" + "type": "string" } }, { - "name": "direction", - "description": "The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`.", - "in": "query", - "required": false, + "name": "pat_request_id", + "in": "path", + "description": "Unique identifier of the request for access via fine-grained personal access token.", + "required": true, "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ] + "type": "integer" } }, { @@ -142698,6 +138100,84 @@ } ], "responses": { + "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" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/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" + } + } + } + } + } + }, "200": { "description": "Response", "content": { @@ -143698,20 +139178,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "repos" + "category": "orgs", + "subcategory": "personal-access-tokens" } - }, - "post": { - "summary": "Create an organization repository", - "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.", + } + }, + "/orgs/{org}/personal-access-tokens": { + "get": { + "summary": "List fine-grained personal access tokens with access to organization resources", + "description": "Lists approved fine-grained personal access tokens owned by organization members that can access organization resources.\n\nOnly GitHub Apps can use this endpoint.", "tags": [ - "repos" + "orgs" ], - "operationId": "repos/create-in-org", + "operationId": "orgs/list-pat-grants", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/repos#create-an-organization-repository" + "url": "https://docs.github.com/rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources" }, "parameters": [ { @@ -143722,1973 +139204,4032 @@ "schema": { "type": "string" } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository." - }, - "description": { - "type": "string", - "description": "A short description of the repository." - }, - "homepage": { - "type": "string", - "description": "A URL with more information about the repository." - }, - "private": { - "type": "boolean", - "description": "Whether the repository is private.", - "default": false - }, - "visibility": { - "type": "string", - "description": "The visibility of the repository.", - "enum": [ - "public", - "private" - ] - }, - "has_issues": { - "type": "boolean", - "description": "Either `true` to enable issues for this repository or `false` to disable them.", - "default": true - }, - "has_projects": { - "type": "boolean", - "description": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", - "default": true - }, - "has_wiki": { - "type": "boolean", - "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", - "default": true - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "is_template": { - "type": "boolean", - "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", - "default": false - }, - "team_id": { - "type": "integer", - "description": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization." - }, - "auto_init": { - "type": "boolean", - "description": "Pass `true` to create an initial commit with empty README.", - "default": false - }, - "gitignore_template": { - "type": "string", - "description": "Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, \"Haskell\"." - }, - "license_template": { - "type": "string", - "description": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\"." - }, - "allow_squash_merge": { - "type": "boolean", - "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", - "default": true - }, - "allow_merge_commit": { - "type": "boolean", - "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", - "default": true - }, - "allow_rebase_merge": { - "type": "boolean", - "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", - "default": true - }, - "allow_auto_merge": { - "type": "boolean", - "description": "Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge.", - "default": false - }, - "delete_branch_on_merge": { - "type": "boolean", - "description": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. **The authenticated user must be an organization owner to set this property to `true`.**", - "default": false - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **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": "Required when using `squash_merge_commit_message`.\n\nThe 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": "Required when using `merge_commit_message`.\n\nThe 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." - }, - "custom_properties": { - "type": "object", - "description": "The custom properties for the new repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - } - }, - "required": [ - "name" - ] + }, + { + "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": "sort", + "description": "The property by which to sort the results.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created_at" + ], + "default": "created_at" + } + }, + { + "name": "direction", + "description": "The direction to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "owner", + "description": "A list of owner usernames to use to filter the results.", + "in": "query", + "required": false, + "schema": { + "type": "array", + "maxItems": 10, + "items": { + "type": "string" }, - "examples": { - "default": { - "value": { - "name": "Hello-World", - "description": "This is your first repository", - "homepage": "https://github.com", - "private": false, - "has_issues": true, - "has_projects": true, - "has_wiki": true - } - } - } + "examples": [ + "owner[]=octocat1,owner[]=octocat2" + ] } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Full Repository", - "description": "Full Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] + }, + { + "name": "repository", + "description": "The name of the repository to use to filter the results.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "examples": [ + "Hello-World" + ] + } + }, + { + "name": "permission", + "description": "The permission to use to filter the results.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "examples": [ + "issues_read" + ] + } + }, + { + "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) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "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) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "name": "token_id", + "description": "The ID of the token", + "in": "query", + "required": false, + "schema": { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + }, + "examples": [ + "token_id[]=1,token_id[]=2" + ] + } + } + ], + "responses": { + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "fork": { - "type": "boolean" + "documentation_url": { + "type": "string" }, "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] + "type": "string" }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] + "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" }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] + "documentation_url": { + "type": "string" }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] + "documentation_url": { + "type": "string" }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] + "url": { + "type": "string" }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] + "documentation_url": { + "type": "string" }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] + "url": { + "type": "string" }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] + "status": { + "type": "string" + } + } + } + } + } + }, + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Organization Programmatic Access Grant", + "description": "Minimal representation of an organization programmatic access grant for enumerations", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the fine-grained personal access token grant. The `pat_id` used to get details about an approved fine-grained personal access token." + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "repository_selection": { + "type": "string", + "enum": [ + "none", + "all", + "subset" + ], + "description": "Type of repository selection requested." + }, + "repositories_url": { + "type": "string", + "description": "URL to the list of repositories the fine-grained personal access token can access. Only follow when `repository_selection` is `subset`." + }, + "permissions": { + "type": "object", + "description": "Permissions requested, categorized by type of permission.", + "properties": { + "organization": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "repository": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "other": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "access_granted_at": { + "type": "string", + "description": "Date and time when the fine-grained personal access token was approved to access the organization." + }, + "token_id": { + "type": "integer", + "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." + }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, + "token_expired": { + "type": "boolean", + "description": "Whether the associated fine-grained personal access token has expired." + }, + "token_expires_at": { + "type": [ + "string", + "null" + ], + "description": "Date and time when the associated fine-grained personal access token expires." + }, + "token_last_used_at": { + "type": [ + "string", + "null" + ], + "description": "Date and time when the associated fine-grained personal access token was last used for authentication." + } }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] + "required": [ + "id", + "owner", + "repository_selection", + "repositories_url", + "permissions", + "access_granted_at", + "token_id", + "token_name", + "token_expired", + "token_expires_at", + "token_last_used_at" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 25381, + "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_selection": "all", + "repositories_url": "https://api.github.com/organizations/652551/personal-access-tokens/25381/repositories", + "permissions": { + "organization": { + "members": "read" + }, + "repository": { + "metadata": "read" + } + }, + "access_granted_at": "2023-05-16T08:47:09.000-07:00", + "token_id": 98716, + "token_name": "Some Token", + "token_expired": false, + "token_expires_at": "2023-11-16T08:47:09.000-07:00", + "token_last_used_at": null + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "personal-access-tokens" + } + }, + "post": { + "summary": "Update the access to organization resources via fine-grained personal access tokens", + "description": "Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access.\n\nOnly GitHub Apps can use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/update-pat-accesses", + "externalDocs": { + "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": [ + { + "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": { + "action": { + "type": "string", + "description": "Action to apply to the fine-grained personal access token.", + "enum": [ + "revoke" + ] + }, + "pat_ids": { + "description": "The IDs of the fine-grained personal access tokens.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the fine-grained personal access token." }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] + "minItems": 1, + "maxItems": 100 + } + }, + "required": [ + "action", + "pat_ids" + ] + }, + "examples": { + "204": { + "summary": "Example of revoking a fine-grained personal access token.", + "value": { + "action": "revoke", + "pat_ids": [ + 1296269, + 1296280 + ] + } + } + } + } + } + }, + "responses": { + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] + "documentation_url": { + "type": "string" }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] + "url": { + "type": "string" }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] + "documentation_url": { + "type": "string" }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] + "url": { + "type": "string" }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] + "status": { + "type": "string" + } + } + } + } + } + }, + "202": { + "description": "Accepted", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] + "documentation_url": { + "type": "string" }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] + "url": { + "type": "string" }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] + "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" }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] + "documentation_url": { + "type": "string" }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "personal-access-tokens" + } + } + }, + "/orgs/{org}/personal-access-tokens/{pat_id}": { + "post": { + "summary": "Update the access a fine-grained personal access token has to organization resources", + "description": "Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access.\n\nOnly GitHub Apps can use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/update-pat-access", + "externalDocs": { + "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": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pat_id", + "description": "The unique identifier of the fine-grained personal access token.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "action": { + "type": "string", + "description": "Action to apply to the fine-grained personal access token.", + "enum": [ + "revoke" + ] + } + }, + "required": [ + "action" + ] + }, + "examples": { + "204": { + "summary": "Example of revoking a fine-grained personal access token.", + "value": { + "action": "revoke" + } + } + } + } + } + }, + "responses": { + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] + "documentation_url": { + "type": "string" }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] + "url": { + "type": "string" }, - "language": { - "type": [ - "string", - "null" - ] + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] + "documentation_url": { + "type": "string" }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] + "url": { + "type": "string" }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] + "status": { + "type": "string" + } + } + } + } + } + }, + "204": { + "description": "A header with no content is returned." + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] + "documentation_url": { + "type": "string" }, - "default_branch": { - "type": "string", - "examples": [ - "master" - ] + "url": { + "type": "string" }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] + "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" }, - "is_template": { - "type": "boolean", - "examples": [ - true - ] + "documentation_url": { + "type": "string" }, - "topics": { + "errors": { "type": "array", "items": { - "type": "string" - }, - "examples": [ - "octocat", - "atom", - "electron", - "API" - ] - }, - "has_issues": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "personal-access-tokens" + } + } + }, + "/orgs/{org}/personal-access-tokens/{pat_id}/repositories": { + "get": { + "summary": "List repositories a fine-grained personal access token has access to", + "description": "Lists the repositories a fine-grained personal access token has access to.\n\nOnly GitHub Apps can use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-pat-grant-repositories", + "externalDocs": { + "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": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pat_id", + "in": "path", + "description": "Unique identifier of the fine-grained personal access token.", + "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": { + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "has_downloads": { - "type": "boolean", - "examples": [ - true - ] + "documentation_url": { + "type": "string" }, - "has_discussions": { - "type": "boolean", - "examples": [ - true - ] + "url": { + "type": "string" }, - "archived": { - "type": "boolean" + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." + "documentation_url": { + "type": "string" }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "type": "string", - "examples": [ - "public" - ] + "url": { + "type": "string" }, - "pushed_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] + "documentation_url": { + "type": "string" }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] + "url": { + "type": "string" }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } + "status": { + "type": "string" + } + } + } + } + } + }, + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "allow_rebase_merge": { - "type": "boolean", - "examples": [ - true - ] - }, - "template_repository": { - "anyOf": [ - { - "type": "null" + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "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" + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "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", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# 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", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "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" + ] } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] } } }, - "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" - ] + "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": [ + { + "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": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "has_discussions": false, + "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 + }, + "security_and_analysis": { + "advanced_security": { + "status": "enabled" + }, + "secret_scanning": { + "status": "enabled" + }, + "secret_scanning_push_protection": { + "status": "disabled" + }, + "secret_scanning_non_provider_patterns": { + "status": "disabled" + } + } + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "personal-access-tokens" + } + } + }, + "/orgs/{org}/private-registries": { + "get": { + "summary": "List private registries for an organization", + "description": "\nLists all private registry configurations 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": [ + "private-registries" + ], + "operationId": "private-registries/list-org-private-registries", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/private-registries/organization-configurations#list-private-registries-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", + "configurations" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "configurations": { + "type": "array", + "items": { + "title": "Organization private registry", + "description": "Private registry configuration for an organization", + "type": "object", + "properties": { + "name": { + "description": "The name of the private registry configuration.", + "type": "string", + "examples": [ + "MAVEN_REPOSITORY_SECRET" + ] + }, + "registry_type": { + "description": "The registry type.", + "enum": [ + "maven_repository", + "nuget_feed", + "goproxy_server", + "npm_registry", + "rubygems_server", + "cargo_registry", + "composer_repository", + "docker_registry", + "git_source", + "helm_registry", + "hex_organization", + "hex_repository", + "pub_repository", + "python_index", + "terraform_registry" + ], + "type": "string" + }, + "username": { + "description": "The username to use when authenticating with the private registry.", + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa" + ] + }, + "visibility": { + "description": "Which type of organization repositories have access to the private registry.", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "name", + "registry_type", + "visibility", + "created_at", + "updated_at" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 1, + "configurations": [ + { + "name": "MAVEN_REPOSITORY_SECRET", + "registry_type": "maven_repository", + "username": "monalisa", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected" } ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "temp_clone_token": { + "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", "null" ] }, - "allow_squash_merge": { - "type": "boolean", - "examples": [ - true + "documentation_url": { + "type": [ + "string", + "null" ] }, - "allow_auto_merge": { - "type": "boolean", - "examples": [ - false + "detail": { + "type": [ + "string", + "null" ] }, - "delete_branch_on_merge": { - "type": "boolean", - "examples": [ - false - ] + "status": { + "type": "integer" }, - "allow_merge_commit": { - "type": "boolean", - "examples": [ - true + "scimType": { + "type": [ + "string", + "null" ] }, - "allow_update_branch": { - "type": "boolean", - "examples": [ - true - ] + "schemas": { + "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" }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "examples": [ - false - ] + "documentation_url": { + "type": "string" }, - "squash_merge_commit_title": { + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "private-registries", + "subcategory": "organization-configurations" + } + }, + "post": { + "summary": "Create a private registry for an organization", + "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [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": [ + "private-registries" + ], + "operationId": "private-registries/create-org-private-registry", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/private-registries/organization-configurations#create-a-private-registry-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": { + "registry_type": { + "description": "The registry type.", + "type": "string", + "enum": [ + "maven_repository", + "nuget_feed", + "goproxy_server", + "npm_registry", + "rubygems_server", + "cargo_registry", + "composer_repository", + "docker_registry", + "git_source", + "helm_registry", + "hex_organization", + "hex_repository", + "pub_repository", + "python_index", + "terraform_registry" + ] + }, + "url": { + "description": "The URL of the private registry.", + "type": "string", + "format": "uri" + }, + "username": { + "description": "The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication.", + "type": [ + "string", + "null" + ] + }, + "encrypted_value": { + "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 private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint.", + "type": "string", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "description": "The ID of the key you used to encrypt the secret.", + "type": "string" + }, + "visibility": { + "description": "Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry.", + "type": "string", + "enum": [ + "all", + "private", + "selected" + ] + }, + "selected_repository_ids": { + "description": "An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. You can manage the list of selected repositories using the [Update a private registry for an organization](https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) endpoint. This field should be omitted if `visibility` is set to `all` or `private`.", + "type": "array", + "items": { + "type": "integer" + } + } + }, + "required": [ + "registry_type", + "url", + "encrypted_value", + "key_id", + "visibility" + ] + }, + "examples": { + "org-private-registry-with-private-visibility": { + "summary": "Example of a private registry configuration with private visibility", + "value": { + "registry_type": "maven_repository", + "url": "https://maven.pkg.github.com/organization/", + "username": "monalisa", + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "private" + } + }, + "org-private-registry-with-selected-visibility": { + "summary": "Example of a private registry configuration with selected visibility", + "value": { + "registry_type": "maven_repository", + "url": "https://maven.pkg.github.com/organization/", + "username": "monalisa", + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "The organization private registry configuration", + "content": { + "application/json": { + "schema": { + "title": "Organization private registry", + "description": "Private registry configuration for an organization", + "type": "object", + "properties": { + "name": { + "description": "The name of the private registry configuration.", "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).", "examples": [ - "PR_TITLE" + "MAVEN_REPOSITORY_SECRET" ] }, - "squash_merge_commit_message": { - "type": "string", + "registry_type": { + "description": "The registry type.", "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" + "maven_repository", + "nuget_feed", + "goproxy_server", + "npm_registry", + "rubygems_server", + "cargo_registry", + "composer_repository", + "docker_registry", + "git_source", + "helm_registry", + "hex_organization", + "hex_repository", + "pub_repository", + "python_index", + "terraform_registry" ], - "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.", - "examples": [ - "PR_BODY" - ] + "type": "string" }, - "merge_commit_title": { + "username": { + "description": "The username to use when authenticating with the private registry.", "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).", "examples": [ - "PR_TITLE" + "monalisa" ] }, - "merge_commit_message": { - "type": "string", + "visibility": { + "description": "Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry.", "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" + "all", + "private", + "selected" ], - "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.", + "type": "string" + }, + "selected_repository_ids": { + "type": "array", + "description": "An array of repository IDs that can access the organization private registry when `visibility` is set to `selected`.", + "items": { + "type": "integer" + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "name", + "registry_type", + "visibility", + "created_at", + "updated_at" + ] + }, + "examples": { + "org-private-registry-with-selected-visibility": { + "value": { + "name": "MAVEN_REPOSITORY_SECRET", + "registry_type": "maven_repository", + "username": "monalisa", + "visibility": "private", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + } + }, + "org-private-registry-with-private-visibility": { + "value": { + "name": "MAVEN_REPOSITORY_SECRET", + "registry_type": "maven_repository", + "username": "monalisa", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 + ], + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "private-registries", + "subcategory": "organization-configurations" + } + } + }, + "/orgs/{org}/private-registries/public-key": { + "get": { + "summary": "Get private registries public key for an organization", + "description": "\nGets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "private-registries" + ], + "operationId": "private-registries/get-org-public-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "key_id", + "key" + ], + "properties": { + "key_id": { + "description": "The identifier for the key.", + "type": "string", "examples": [ - "PR_BODY" + "012345678912345678" ] }, - "allow_forking": { - "type": "boolean", + "key": { + "description": "The Base64 encoded public key.", + "type": "string", "examples": [ - true + "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" ] + } + } + }, + "examples": { + "default": { + "value": { + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + } + } + } + } + }, + "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" }, - "web_commit_signoff_required": { - "type": "boolean", + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "private-registries", + "subcategory": "organization-configurations" + } + } + }, + "/orgs/{org}/private-registries/{secret_name}": { + "get": { + "summary": "Get a private registry for an organization", + "description": "\nGet the configuration of a single private registry defined for an organization, omitting its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "private-registries" + ], + "operationId": "private-registries/get-org-private-registry", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization" + }, + "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": "The specified private registry configuration for the organization", + "content": { + "application/json": { + "schema": { + "title": "Organization private registry", + "description": "Private registry configuration for an organization", + "type": "object", + "properties": { + "name": { + "description": "The name of the private registry configuration.", + "type": "string", "examples": [ - false + "MAVEN_REPOSITORY_SECRET" ] }, - "subscribers_count": { + "registry_type": { + "description": "The registry type.", + "enum": [ + "maven_repository", + "nuget_feed", + "goproxy_server", + "npm_registry", + "rubygems_server", + "cargo_registry", + "composer_repository", + "docker_registry", + "git_source", + "helm_registry", + "hex_organization", + "hex_repository", + "pub_repository", + "python_index", + "terraform_registry" + ], + "type": "string" + }, + "username": { + "description": "The username to use when authenticating with the private registry.", + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa" + ] + }, + "visibility": { + "description": "Which type of organization repositories have access to the private registry.", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "name", + "registry_type", + "visibility", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "name": "MAVEN_REPOSITORY_SECRET", + "registry_type": "maven_repository", + "username": "monalisa", + "visibility": "private", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/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": "private-registries", + "subcategory": "organization-configurations" + } + }, + "patch": { + "summary": "Update a private registry for an organization", + "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [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": [ + "private-registries" + ], + "operationId": "private-registries/update-org-private-registry", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization" + }, + "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": { + "registry_type": { + "description": "The registry type.", + "type": "string", + "enum": [ + "maven_repository", + "nuget_feed", + "goproxy_server", + "npm_registry", + "rubygems_server", + "cargo_registry", + "composer_repository", + "docker_registry", + "git_source", + "helm_registry", + "hex_organization", + "hex_repository", + "pub_repository", + "python_index", + "terraform_registry" + ] + }, + "url": { + "description": "The URL of the private registry.", + "type": "string", + "format": "uri" + }, + "username": { + "description": "The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication.", + "type": [ + "string", + "null" + ] + }, + "encrypted_value": { + "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 private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint.", + "type": "string", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "description": "The ID of the key you used to encrypt the secret.", + "type": "string" + }, + "visibility": { + "description": "Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry.", + "type": "string", + "enum": [ + "all", + "private", + "selected" + ] + }, + "selected_repository_ids": { + "description": "An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. This field should be omitted if `visibility` is set to `all` or `private`.", + "type": "array", + "items": { + "type": "integer" + } + } + } + }, + "examples": { + "default": { + "value": { + "username": "monalisa", + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "private-registries", + "subcategory": "organization-configurations" + } + }, + "delete": { + "summary": "Delete a private registry for an organization", + "description": "\nDelete a private registry configuration at the organization-level.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "private-registries" + ], + "operationId": "private-registries/delete-org-private-registry", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization" + }, + "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" + }, + "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "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": "private-registries", + "subcategory": "organization-configurations" + } + } + }, + "/orgs/{org}/projects": { + "get": { + "summary": "List organization projects", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "tags": [ + "projects-classic" + ], + "operationId": "projects-classic/list-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects-classic/projects#list-organization-projects" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "state", + "description": "Indicates the state of the projects to return.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "open", + "closed", + "all" + ], + "default": "open" + } + }, + { + "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": "Project", + "description": "Projects are a way to organize columns and cards of work.", + "type": "object", + "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/api-playground/projects-test/projects/12" + ] + }, + "columns_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604/columns" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6UHJvamVjdDEwMDI2MDQ=" + ] + }, + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", + "type": [ + "string", + "null" + ], + "examples": [ + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "type": "string", + "enum": [ + "read", + "write", + "admin", + "none" + ] + }, + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "number", + "name", + "body", + "state", + "url", + "html_url", + "owner_url", + "creator", + "columns_url", + "created_at", + "updated_at" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "owner_url": "https://api.github.com/orgs/octocat", + "url": "https://api.github.com/projects/1002605", + "html_url": "https://github.com/orgs/api-playground/projects/1", + "columns_url": "https://api.github.com/projects/1002605/columns", + "id": 1002605, + "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", + "name": "Organization Roadmap", + "body": "High-level roadmap for the upcoming year.", + "number": 1, + "state": "open", + "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 + }, + "created_at": "2011-04-11T20:09:31Z", + "updated_at": "2014-03-04T18:58:10Z", + "organization_permission": "write", + "private": true + } + ] + } + } + } + }, + "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 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": "projects-classic", + "subcategory": "projects", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true + }, + "post": { + "summary": "Create an organization project", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "tags": [ + "projects-classic" + ], + "operationId": "projects-classic/create-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects-classic/projects#create-an-organization-project" + }, + "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 project." + }, + "body": { + "type": "string", + "description": "The description of the project." + } + }, + "required": [ + "name" + ] + }, + "examples": { + "default": { + "value": { + "name": "Organization Roadmap", + "body": "High-level roadmap for the upcoming year." + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", + "type": "object", + "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/api-playground/projects-test/projects/12" + ] + }, + "columns_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604/columns" + ] + }, + "id": { "type": "integer", "examples": [ - 42 + 1002604 ] }, - "network_count": { + "node_id": { + "type": "string", + "examples": [ + "MDc6UHJvamVjdDEwMDI2MDQ=" + ] + }, + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", + "type": [ + "string", + "null" + ], + "examples": [ + "This project represents the sprint of the first week in January" + ] + }, + "number": { "type": "integer", "examples": [ - 0 + 1 ] }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" ] }, - "organization": { + "creator": { "anyOf": [ { "type": "null" @@ -145863,306 +143404,557 @@ } ] }, - "parent": { - "title": "Repository", - "description": "A repository on GitHub.", + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "type": "string", + "enum": [ + "read", + "write", + "admin", + "none" + ] + }, + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "number", + "name", + "body", + "state", + "url", + "html_url", + "owner_url", + "creator", + "columns_url", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "owner_url": "https://api.github.com/orgs/octocat", + "url": "https://api.github.com/projects/1002605", + "html_url": "https://github.com/orgs/api-playground/projects/1", + "columns_url": "https://api.github.com/projects/1002605/columns", + "id": 1002605, + "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", + "name": "Organization Roadmap", + "body": "High-level roadmap for the upcoming year.", + "number": 1, + "state": "open", + "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 + }, + "created_at": "2011-04-11T20:09:31Z", + "updated_at": "2014-03-04T18:58:10Z" + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "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 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": "projects-classic", + "subcategory": "projects", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true + } + }, + "/orgs/{org}/properties/schema": { + "get": { + "summary": "Get all custom properties for an organization", + "description": "Gets all custom properties defined for an organization.\nOrganization members can read these properties.", + "tags": [ + "orgs" + ], + "operationId": "orgs/get-all-custom-properties", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/custom-properties#get-all-custom-properties-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": "array", + "items": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "examples": [ + "organization" + ] + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": [ + "string", + "null" + ], + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "org_actors" + ] + } + }, + "required": [ + "property_name", + "value_type" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "property_name": "environment", + "url": "https://api.github.com/orgs/github/properties/schema/environment", + "source_type": "organization", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ], + "values_editable_by": "org_actors" + }, + { + "property_name": "service", + "url": "https://api.github.com/orgs/github/properties/schema/service", + "source_type": "organization", + "value_type": "string" + }, + { + "property_name": "team", + "url": "https://api.github.com/orgs/github/properties/schema/team", + "source_type": "organization", + "value_type": "string", + "description": "Team owning the repository" + } + ] + } + } + } + } + }, + "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": "custom-properties" + } + }, + "patch": { + "summary": "Create or update custom properties for an organization", + "description": "Creates new or updates existing custom properties defined for an organization in a batch.\n\nIf the property already exists, the existing property will be replaced with the new values.\nMissing optional values will fall back to default values, previous values will be overwritten.\nE.g. if a property exists with `values_editable_by: org_and_repo_actors` and it's updated without specifying `values_editable_by`, it will be updated to default value `org_actors`.\n\nTo use this endpoint, the authenticated user must be one of:\n - An administrator for the organization.\n - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/create-or-update-custom-properties", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-properties-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": { + "properties": { + "type": "array", + "description": "The array of custom properties to create or update.", + "items": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", "type": "object", "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] + "property_name": { + "type": "string", + "description": "The name of the property" }, - "node_id": { + "url": { "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." }, - "name": { - "description": "The name of the repository.", + "source_type": { "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], "examples": [ - "Team Environment" + "organization" ] }, - "full_name": { + "value_type": { "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", "examples": [ - "octocat/Hello-World" + "single_select" ] }, - "license": { - "anyOf": [ + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ { - "type": "null" + "type": "string" }, { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] + "type": "array", + "items": { + "type": "string" + } } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" ] }, "description": { @@ -146170,2362 +143962,1283 @@ "string", "null" ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] + "description": "Short description of the property" }, - "mirror_url": { + "allowed_values": { "type": [ - "string", + "array", "null" ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." }, - "homepage": { + "values_editable_by": { "type": [ "string", "null" ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ], + "description": "Who can edit the values of the property", "examples": [ - 108 + "org_actors" ] - }, - "default_branch": { - "description": "The default branch of the repository.", + } + }, + "required": [ + "property_name", + "value_type" + ] + }, + "minItems": 1, + "maxItems": 100 + } + }, + "required": [ + "properties" + ] + }, + "examples": { + "default": { + "value": { + "properties": [ + { + "property_name": "environment", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ], + "values_editable_by": "org_actors" + }, + { + "property_name": "service", + "value_type": "string" + }, + { + "property_name": "team", + "value_type": "string", + "description": "Team owning the repository" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "examples": [ + "organization" + ] + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] + "maxLength": 75 }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": [ + "string", + "null" + ], + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "org_actors" + ] + } + }, + "required": [ + "property_name", + "value_type" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "property_name": "environment", + "url": "https://api.github.com/orgs/github/properties/schema/environment", + "source_type": "organization", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ], + "values_editable_by": "org_actors" + }, + { + "property_name": "service", + "url": "https://api.github.com/orgs/github/properties/schema/service", + "source_type": "organization", + "value_type": "string" + }, + { + "property_name": "team", + "url": "https://api.github.com/orgs/github/properties/schema/team", + "source_type": "organization", + "value_type": "string", + "description": "Team owning the repository" + } + ] + } + } + } + } + }, + "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": "custom-properties" + } + } + }, + "/orgs/{org}/properties/schema/{custom_property_name}": { + "get": { + "summary": "Get a custom property for an organization", + "description": "Gets a custom property that is defined for an organization.\nOrganization members can read these properties.", + "tags": [ + "orgs" + ], + "operationId": "orgs/get-custom-property", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "custom_property_name", + "description": "The custom property name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "examples": [ + "organization" + ] + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" }, - "topics": { + { "type": "array", "items": { "type": "string" } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": [ + "string", + "null" + ], + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "org_actors" + ] + } + }, + "required": [ + "property_name", + "value_type" + ] + }, + "examples": { + "default": { + "value": { + "property_name": "environment", + "url": "https://api.github.com/orgs/github/properties/schema/environment", + "source_type": "organization", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + } + } + } + } + } + }, + "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": "custom-properties" + } + }, + "put": { + "summary": "Create or update a custom property for an organization", + "description": "Creates a new or updates an existing custom property that is defined for an organization.\n\nTo use this endpoint, the authenticated user must be one of:\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/create-or-update-custom-property", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "custom_property_name", + "description": "The custom property name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Custom Property Set Payload", + "description": "Custom property set payload", + "type": "object", + "properties": { + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { + } + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": [ + "string", + "null" + ], + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "org_actors" + ] + } + }, + "required": [ + "value_type" + ] + }, + "examples": { + "default": { + "value": { + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "examples": [ + "organization" + ] + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { "type": "string" }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } + { + "type": "array", + "items": { + "type": "string" } } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 }, - "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" + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": [ + "string", + "null" + ], + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "org_actors" + ] + } + }, + "required": [ + "property_name", + "value_type" + ] + }, + "examples": { + "default": { + "value": { + "property_name": "environment", + "url": "https://api.github.com/orgs/github/properties/schema/environment", + "source_type": "organization", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" ] + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "source": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", + "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": "custom-properties" + } + }, + "delete": { + "summary": "Remove a custom property for an organization", + "description": "Removes a custom property that is defined for an organization.\n\nTo use this endpoint, the authenticated user must be one of:\n - An administrator for the organization.\n - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/remove-custom-property", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "custom_property_name", + "description": "The custom property name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "A header with no content is returned." + }, + "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": "custom-properties" + } + } + }, + "/orgs/{org}/properties/values": { + "get": { + "summary": "List custom property values for organization repositories", + "description": "Lists organization repositories with all of their custom property values.\nOrganization members can read these properties.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-custom-properties-values-for-repos", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories" + }, + "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": "repository_query", + "description": "Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)\" for a detailed list of qualifiers.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Organization Repository Custom Property Values", + "description": "List of custom property values for a repository", + "type": "object", + "properties": { + "repository_id": { + "type": "integer", + "examples": [ + 1296269 + ] + }, + "repository_name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "repository_full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" + "type": "array", + "items": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] + "value": { + "oneOf": [ + { + "type": "string" }, - "html_url": { - "type": "string", - "format": "uri" + { + "type": "array", + "items": { + "type": "string" + } } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" + ], + "description": "The value assigned to the property", + "type": [ + "null", + "string", + "array" ] } - ] - }, - "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" + "property_name", + "value" ] }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + "description": "List of custom property names and associated values" + } + }, + "required": [ + "repository_id", + "repository_name", + "repository_full_name", + "properties" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "repository_id": 1296269, + "repository_name": "Hello-World", + "repository_full_name": "octocat/Hello-World", + "properties": [ + { + "property_name": "environment", + "value": "production" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" } - } - }, - "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" - ] + ] + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "forks": { - "type": "integer" + "documentation_url": { + "type": "string" }, - "master_branch": { + "url": { "type": "string" }, - "open_issues": { - "type": "integer" + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "watchers": { - "type": "integer" + "documentation_url": { + "type": "string" }, - "anonymous_access_enabled": { - "description": "Whether anonymous git access is allowed.", - "default": true, - "type": "boolean" + "url": { + "type": "string" }, - "code_of_conduct": { - "title": "Code Of Conduct Simple", - "description": "Code of Conduct Simple", + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-properties" + } + }, + "patch": { + "summary": "Create or update custom property values for organization repositories", + "description": "Create new or update existing custom property values for repositories in a batch that belong to an organization.\nEach target repository will have its custom property values updated to match the values provided in the request.\n\nA maximum of 30 repositories can be updated in a single request.\n\nUsing a value of `null` for a custom property will remove or 'unset' the property value from the repository.\n\nTo use this endpoint, the authenticated user must be one of:\n - An administrator for the organization.\n - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/create-or-update-custom-properties-values-for-repos", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories" + }, + "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": { + "repository_names": { + "type": "array", + "description": "The names of repositories that the custom property values will be applied to.", + "items": { + "type": "string" + }, + "minItems": 1, + "maxItems": 30 + }, + "properties": { + "type": "array", + "description": "List of custom property names and associated values to apply to the repositories.", + "items": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/github/docs/community/code_of_conduct" - ] - }, - "key": { - "type": "string", - "examples": [ - "citizen_code_of_conduct" - ] - }, - "name": { + "property_name": { "type": "string", - "examples": [ - "Citizen Code of Conduct" - ] + "description": "The name of the property" }, - "html_url": { + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "The value assigned to the property", "type": [ + "null", "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md" + "array" ] } }, "required": [ - "url", - "key", - "name", - "html_url" + "property_name", + "value" ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "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", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "has_discussions", - "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", - "network_count", - "subscribers_count" - ] + } }, - "examples": { - "default": { - "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}", - "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", - "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" - }, - "language": null, - "forks_count": 9, - "forks": 9, - "stargazers_count": 80, - "watchers_count": 80, - "watchers": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "open_issues": 0, - "is_template": false, - "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": { - "pull": true, - "push": false, - "admin": false - }, - "allow_rebase_merge": true, - "template_repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World-Template", - "full_name": "octocat/Hello-World-Template", - "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-Template", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World-Template", - "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World-Template.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World-Template.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World-Template.git", - "mirror_url": "git:git.example.com/octocat/Hello-World-Template", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World-Template", - "homepage": "https://github.com", - "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, - "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", - "allow_squash_merge": true, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "allow_forking": true, - "web_commit_signoff_required": false, - "subscribers_count": 42, - "network_count": 0, - "organization": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "Organization", - "site_admin": false + "required": [ + "repository_names", + "properties" + ] + }, + "examples": { + "default": { + "value": { + "repository_names": [ + "Hello-World", + "octo-repo" + ], + "properties": [ + { + "property_name": "environment", + "value": "production" }, - "parent": { - "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, - "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://api.github.com/licenses/mit" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 + { + "property_name": "service", + "value": "web" }, - "source": { - "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, - "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://api.github.com/licenses/mit" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 + { + "property_name": "team", + "value": "octocat" } - } + ] } } } - }, - "headers": { - "Location": { - "example": "https://api.github.com/repos/octocat/Hello-World", + } + } + }, + "responses": { + "204": { + "description": "No Content when custom property values are successfully created or updated" + }, + "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" + } + } } } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -148629,28 +145342,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "repos" + "category": "orgs", + "subcategory": "custom-properties" } } }, - "/orgs/{org}/rulesets": { + "/orgs/{org}/public_members": { "get": { - "summary": "Get all organization repository rulesets", - "description": "Get all the repository rulesets for an organization.", + "summary": "List public organization members", + "description": "Members of an organization can choose to have their membership publicized or not.", "tags": [ - "repos" + "orgs" ], - "operationId": "repos/get-org-rulesets", + "operationId": "orgs/list-public-members", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/rules#get-all-organization-repository-rulesets" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "rules" + "url": "https://docs.github.com/rest/orgs/members#list-public-organization-members" }, "parameters": [ { @@ -148679,18 +145386,6 @@ "type": "integer", "default": 1 } - }, - { - "name": "targets", - "description": "A comma-separated list of rule targets to filter by.\nIf provided, only rulesets that apply to the specified targets will be returned.\nFor example, `branch,tag,push`.\n", - "in": "query", - "required": false, - "schema": { - "type": "string", - "examples": [ - "branch,tag,push" - ] - } } ], "responses": { @@ -148701,1325 +145396,304 @@ "schema": { "type": "array", "items": { - "title": "Repository ruleset", + "title": "Simple User", + "description": "A GitHub user.", "type": "object", - "description": "A set of rules to apply when specified conditions are met.", - "required": [ - "id", - "name", - "source", - "enforcement" - ], "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, "id": { "type": "integer", - "description": "The ID of the ruleset" + "format": "int64", + "examples": [ + 1 + ] }, - "name": { + "node_id": { "type": "string", - "description": "The name of the ruleset" + "examples": [ + "MDQ6VXNlcjE=" + ] }, - "target": { + "avatar_url": { "type": "string", - "description": "The target of the ruleset", - "enum": [ - "branch", - "tag", - "push", - "repository" + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" ] }, - "source_type": { + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { "type": "string", - "description": "The type of the source of the ruleset", - "enum": [ - "Repository", - "Organization", - "Enterprise" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" ] }, - "source": { + "html_url": { "type": "string", - "description": "The name of the source" + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] }, - "enforcement": { + "followers_url": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).", - "enum": [ - "disabled", - "active", - "evaluate" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" ] }, - "bypass_actors": { - "type": "array", - "description": "The actors that can bypass the rules in this ruleset", - "items": { - "title": "Repository Ruleset Bypass Actor", - "type": "object", - "description": "An actor that can bypass rules in a ruleset", - "required": [ - "actor_type" - ], - "properties": { - "actor_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." - }, - "actor_type": { - "type": "string", - "enum": [ - "Integration", - "OrganizationAdmin", - "RepositoryRole", - "Team", - "DeployKey" - ], - "description": "The type of actor that can bypass a ruleset." - }, - "bypass_mode": { - "type": "string", - "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", - "enum": [ - "always", - "pull_request" - ], - "default": "always" - } - } - } + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] }, - "current_user_can_bypass": { + "gists_url": { "type": "string", - "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", - "enum": [ - "always", - "pull_requests_only", - "never" + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "node_id": { - "type": "string" + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The URL of the ruleset" - } - } - }, - "html": { - "type": [ - "object", - "null" - ], - "properties": { - "href": { - "type": "string", - "description": "The html URL of the ruleset" - } - } - } - } + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] }, - "conditions": { - "anyOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Organization ruleset conditions", - "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", - "oneOf": [ - { - "type": "object", - "title": "repository_name_and_ref_name", - "description": "Conditions to target repositories by name and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository names", - "type": "object", - "description": "Parameters for a repository name condition", - "properties": { - "repository_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - }, - "protected": { - "type": "boolean", - "description": "Whether renaming of target repositories is prevented." - } - } - } - }, - "required": [ - "repository_name" - ] - } - ] - }, - { - "type": "object", - "title": "repository_id_and_ref_name", - "description": "Conditions to target repositories by id and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository IDs", - "type": "object", - "description": "Parameters for a repository ID condition", - "properties": { - "repository_id": { - "type": "object", - "properties": { - "repository_ids": { - "type": "array", - "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", - "items": { - "type": "integer" - } - } - } - } - }, - "required": [ - "repository_id" - ] - } - ] - }, - { - "type": "object", - "title": "repository_property_and_ref_name", - "description": "Conditions to target repositories by property and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository properties", - "type": "object", - "description": "Parameters for a repository property condition", - "properties": { - "repository_property": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - }, - "exclude": { - "type": "array", - "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - } - } - } - }, - "required": [ - "repository_property" - ] - } - ] - } - ] - } - ], - "type": [ - "null", - "object" + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" ] }, - "rules": { - "type": "array", - "items": { - "title": "Repository Rule", - "type": "object", - "description": "A repository rule.", - "oneOf": [ - { - "title": "creation", - "description": "Only allow users with bypass permission to create matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "creation" - ] - } - } - }, - { - "title": "update", - "description": "Only allow users with bypass permission to update matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "update" - ] - }, - "parameters": { - "type": "object", - "properties": { - "update_allows_fetch_and_merge": { - "type": "boolean", - "description": "Branch can pull changes from its upstream repository" - } - }, - "required": [ - "update_allows_fetch_and_merge" - ] - } - } - }, - { - "title": "deletion", - "description": "Only allow users with bypass permissions to delete matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "deletion" - ] - } - } - }, - { - "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_linear_history" - ] - } - } - }, - { - "title": "merge_queue", - "description": "Merges must be performed via a merge queue.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "merge_queue" - ] - }, - "parameters": { - "type": "object", - "properties": { - "check_response_timeout_minutes": { - "type": "integer", - "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", - "minimum": 1, - "maximum": 360 - }, - "grouping_strategy": { - "type": "string", - "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", - "enum": [ - "ALLGREEN", - "HEADGREEN" - ] - }, - "max_entries_to_build": { - "type": "integer", - "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", - "minimum": 0, - "maximum": 100 - }, - "max_entries_to_merge": { - "type": "integer", - "description": "The maximum number of PRs that will be merged together in a group.", - "minimum": 0, - "maximum": 100 - }, - "merge_method": { - "type": "string", - "description": "Method to use when merging changes from queued pull requests.", - "enum": [ - "MERGE", - "SQUASH", - "REBASE" - ] - }, - "min_entries_to_merge": { - "type": "integer", - "description": "The minimum number of PRs that will be merged together in a group.", - "minimum": 0, - "maximum": 100 - }, - "min_entries_to_merge_wait_minutes": { - "type": "integer", - "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", - "minimum": 0, - "maximum": 360 - } - }, - "required": [ - "check_response_timeout_minutes", - "grouping_strategy", - "max_entries_to_build", - "max_entries_to_merge", - "merge_method", - "min_entries_to_merge", - "min_entries_to_merge_wait_minutes" - ] - } - } - }, - { - "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_deployments" - ] - }, - "parameters": { - "type": "object", - "properties": { - "required_deployment_environments": { - "type": "array", - "description": "The environments that must be successfully deployed to before branches can be merged.", - "items": { - "type": "string" - } - } - }, - "required": [ - "required_deployment_environments" - ] - } - } - }, - { - "title": "required_signatures", - "description": "Commits pushed to matching refs must have verified signatures.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_signatures" - ] - } - } - }, - { - "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.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "pull_request" - ] - }, - "parameters": { - "type": "object", - "properties": { - "allowed_merge_methods": { - "type": "array", - "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", - "items": { - "type": "string", - "enum": [ - "merge", - "squash", - "rebase" - ] - } - }, - "automatic_copilot_code_review_enabled": { - "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean", - "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." - }, - "require_code_owner_review": { - "type": "boolean", - "description": "Require an approving review in pull requests that modify files that have a designated code owner." - }, - "require_last_push_approval": { - "type": "boolean", - "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." - }, - "required_approving_review_count": { - "type": "integer", - "description": "The number of approving reviews that are required before a pull request can be merged.", - "minimum": 0, - "maximum": 10 - }, - "required_review_thread_resolution": { - "type": "boolean", - "description": "All conversations on code must be resolved before a pull request can be merged." - } - }, - "required": [ - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "require_last_push_approval", - "required_approving_review_count", - "required_review_thread_resolution" - ] - } - } - }, - { - "title": "required_status_checks", - "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_status_checks" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "required_status_checks": { - "type": "array", - "description": "Status checks that are required.", - "items": { - "title": "StatusCheckConfiguration", - "description": "Required status check", - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "The status check context name that must be present on the commit." - }, - "integration_id": { - "type": "integer", - "description": "The optional integration ID that this status check must originate from." - } - }, - "required": [ - "context" - ] - } - }, - "strict_required_status_checks_policy": { - "type": "boolean", - "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." - } - }, - "required": [ - "required_status_checks", - "strict_required_status_checks_policy" - ] - } - } - }, - { - "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "non_fast_forward" - ] - } - } - }, - { - "title": "commit_message_pattern", - "description": "Parameters to be used for the commit_message_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_message_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "commit_author_email_pattern", - "description": "Parameters to be used for the commit_author_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_author_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "committer_email_pattern", - "description": "Parameters to be used for the committer_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "committer_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "branch_name_pattern", - "description": "Parameters to be used for the branch_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "branch_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "tag_name_pattern", - "description": "Parameters to be used for the tag_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tag_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - } - ] - } + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] }, - "created_at": { + "events_url": { "type": "string", - "format": "date-time" + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] }, - "updated_at": { + "received_events_url": { "type": "string", - "format": "date-time" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] } }, "examples": { "default": { "value": [ { - "id": 21, - "name": "super cool ruleset", - "source_type": "Organization", - "source": "my-org", - "enforcement": "enabled", - "node_id": "RRS_lACkVXNlcgQB", - "_links": { - "self": { - "href": "https://api.github.com/orgs/my-org/rulesets/21" - }, - "html": { - "href": "https://github.com/organizations/my-org/settings/rules/21" - } - }, - "created_at": "2023-07-15T08:43:03Z", - "updated_at": "2023-08-23T16:29:47Z" - }, - { - "id": 432, - "name": "Another ruleset", - "source_type": "Organization", - "source": "my-org", - "enforcement": "enabled", - "node_id": "RRS_lACkVXNlcgQQ", - "_links": { - "self": { - "href": "https://api.github.com/orgs/my-org/rulesets/432" - }, - "html": { - "href": "https://github.com/organizations/my-org/settings/rules/432" - } - }, - "created_at": "2023-08-15T08:43:03Z", - "updated_at": "2023-09-23T16:29:47Z" + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false } ] } } } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } + "type": "string" } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "members" + } + } + }, + "/orgs/{org}/public_members/{username}": { + "get": { + "summary": "Check public organization membership for a user", + "description": "Check if the provided user is a public member of the organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/check-public-membership-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/members#check-public-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" + } }, - "500": { - "description": "Internal Error", + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response if user is a public member" + }, + "404": { + "description": "Not Found if user is not a public member" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "members" + } + }, + "put": { + "summary": "Set public organization membership for the authenticated user", + "description": "The user can publicize their own membership. (A user cannot publicize the membership for another user.)\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "tags": [ + "orgs" + ], + "operationId": "orgs/set-public-membership-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/members#set-public-organization-membership-for-the-authenticated-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" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -150044,24 +145718,69 @@ } } } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "orgs", + "subcategory": "members" } }, - "post": { - "summary": "Create an organization repository ruleset", - "description": "Create a repository ruleset for an organization.", + "delete": { + "summary": "Remove public organization membership for the authenticated user", + "description": "Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.", "tags": [ - "repos" + "orgs" ], - "operationId": "repos/create-org-ruleset", + "operationId": "orgs/remove-public-membership-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/rules#create-an-organization-repository-ruleset" + "url": "https://docs.github.com/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-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" + } + } + ], + "responses": { + "204": { + "description": "Response" + } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, + "enabledForGitHubApps": false, "category": "orgs", - "subcategory": "rules" + "subcategory": "members" + } + } + }, + "/orgs/{org}/repos": { + "get": { + "summary": "List organization repositories", + "description": "Lists repositories for the specified organization.\n\n> [!NOTE]\n> In order to see the `security_and_analysis` block for a repository 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).\"", + "tags": [ + "repos" + ], + "operationId": "repos/list-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#list-organization-repositories" }, "parameters": [ { @@ -150072,2512 +145791,1088 @@ "schema": { "type": "string" } + }, + { + "name": "type", + "description": "Specifies the types of repositories you want returned.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "all", + "public", + "private", + "forks", + "sources", + "member" + ], + "default": "all" + } + }, + { + "name": "sort", + "description": "The property to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "pushed", + "full_name" + ], + "default": "created" + } + }, + { + "name": "direction", + "description": "The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "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/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": { - "description": "Request body", - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the ruleset." - }, - "target": { - "type": "string", - "description": "The target of the ruleset", - "enum": [ - "branch", - "tag", - "push", - "repository" - ], - "default": "branch" - }, - "enforcement": { - "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).", - "enum": [ - "disabled", - "active", - "evaluate" - ] - }, - "bypass_actors": { - "type": "array", - "description": "The actors that can bypass the rules in this ruleset", - "items": { - "title": "Repository Ruleset Bypass Actor", - "type": "object", - "description": "An actor that can bypass rules in a ruleset", - "required": [ - "actor_type" - ], - "properties": { - "actor_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." - }, - "actor_type": { - "type": "string", - "enum": [ - "Integration", - "OrganizationAdmin", - "RepositoryRole", - "Team", - "DeployKey" - ], - "description": "The type of actor that can bypass a ruleset." - }, - "bypass_mode": { - "type": "string", - "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", - "enum": [ - "always", - "pull_request" - ], - "default": "always" - } - } - } - }, - "conditions": { - "title": "Organization ruleset conditions", + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", - "oneOf": [ - { - "type": "object", - "title": "repository_name_and_ref_name", - "description": "Conditions to target repositories by name and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository names", - "type": "object", - "description": "Parameters for a repository name condition", - "properties": { - "repository_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - }, - "protected": { - "type": "boolean", - "description": "Whether renaming of target repositories is prevented." - } - } - } - }, - "required": [ - "repository_name" - ] - } + "properties": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 ] }, - { - "type": "object", - "title": "repository_id_and_ref_name", - "description": "Conditions to target repositories by id and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository IDs", - "type": "object", - "description": "Parameters for a repository ID condition", - "properties": { - "repository_id": { - "type": "object", - "properties": { - "repository_ids": { - "type": "array", - "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", - "items": { - "type": "integer" - } - } - } - } - }, - "required": [ - "repository_id" - ] - } + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - { + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", - "title": "repository_property_and_ref_name", - "description": "Conditions to target repositories by property and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - { - "title": "Repository ruleset conditions for repository properties", - "type": "object", - "description": "Parameters for a repository property condition", - "properties": { - "repository_property": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - }, - "exclude": { - "type": "array", - "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - } - } - } - }, - "required": [ - "repository_property" + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] - } - ] - } - ] - }, - "rules": { - "type": "array", - "description": "An array of rules within the ruleset.", - "items": { - "title": "Repository Rule", - "type": "object", - "description": "A repository rule.", - "oneOf": [ - { - "title": "creation", - "description": "Only allow users with bypass permission to create matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "creation" - ] - } - } - }, - { - "title": "update", - "description": "Only allow users with bypass permission to update matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "update" - ] - }, - "parameters": { - "type": "object", - "properties": { - "update_allows_fetch_and_merge": { - "type": "boolean", - "description": "Branch can pull changes from its upstream repository" - } - }, - "required": [ - "update_allows_fetch_and_merge" - ] - } - } - }, - { - "title": "deletion", - "description": "Only allow users with bypass permissions to delete matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "deletion" - ] - } - } - }, - { - "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_linear_history" - ] - } - } - }, - { - "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_deployments" - ] - }, - "parameters": { - "type": "object", - "properties": { - "required_deployment_environments": { - "type": "array", - "description": "The environments that must be successfully deployed to before branches can be merged.", - "items": { - "type": "string" - } - } - }, - "required": [ - "required_deployment_environments" - ] - } - } - }, - { - "title": "required_signatures", - "description": "Commits pushed to matching refs must have verified signatures.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_signatures" - ] - } - } - }, - { - "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.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "pull_request" - ] - }, - "parameters": { - "type": "object", - "properties": { - "allowed_merge_methods": { - "type": "array", - "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", - "items": { - "type": "string", - "enum": [ - "merge", - "squash", - "rebase" - ] - } - }, - "automatic_copilot_code_review_enabled": { - "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean", - "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." - }, - "require_code_owner_review": { - "type": "boolean", - "description": "Require an approving review in pull requests that modify files that have a designated code owner." - }, - "require_last_push_approval": { - "type": "boolean", - "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." - }, - "required_approving_review_count": { - "type": "integer", - "description": "The number of approving reviews that are required before a pull request can be merged.", - "minimum": 0, - "maximum": 10 - }, - "required_review_thread_resolution": { - "type": "boolean", - "description": "All conversations on code must be resolved before a pull request can be merged." - } - }, - "required": [ - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "require_last_push_approval", - "required_approving_review_count", - "required_review_thread_resolution" - ] - } - } - }, - { - "title": "required_status_checks", - "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_status_checks" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "required_status_checks": { - "type": "array", - "description": "Status checks that are required.", - "items": { - "title": "StatusCheckConfiguration", - "description": "Required status check", - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "The status check context name that must be present on the commit." - }, - "integration_id": { - "type": "integer", - "description": "The optional integration ID that this status check must originate from." - } - }, - "required": [ - "context" - ] - } - }, - "strict_required_status_checks_policy": { - "type": "boolean", - "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." - } - }, - "required": [ - "required_status_checks", - "strict_required_status_checks_policy" - ] - } - } - }, - { - "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "non_fast_forward" - ] - } } }, - { - "title": "commit_message_pattern", - "description": "Parameters to be used for the commit_message_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_message_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "commit_author_email_pattern", - "description": "Parameters to be used for the commit_author_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_author_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "committer_email_pattern", - "description": "Parameters to be used for the committer_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "committer_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "branch_name_pattern", - "description": "Parameters to be used for the branch_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "branch_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "tag_name_pattern", - "description": "Parameters to be used for the tag_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tag_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "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" } - ] - } - } - }, - "required": [ - "name", - "enforcement" - ] - }, - "examples": { - "default": { - "value": { - "name": "super cool ruleset", - "target": "branch", - "enforcement": "active", - "bypass_actors": [ - { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" - } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" + }, + "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", + "null" ], - "exclude": [ - "refs/heads/dev*" + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" ] }, - "repository_name": { - "include": [ - "important_repository", - "another_important_repository" + "created_at": { + "type": [ + "string", + "null" ], - "exclude": [ - "unimportant_repository" + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" ], - "protected": true - } - }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } - } - ] - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Repository ruleset", - "type": "object", - "description": "A set of rules to apply when specified conditions are met.", - "required": [ - "id", - "name", - "source", - "enforcement" - ], - "properties": { - "id": { - "type": "integer", - "description": "The ID of the ruleset" - }, - "name": { - "type": "string", - "description": "The name of the ruleset" - }, - "target": { - "type": "string", - "description": "The target of the ruleset", - "enum": [ - "branch", - "tag", - "push", - "repository" - ] - }, - "source_type": { - "type": "string", - "description": "The type of the source of the ruleset", - "enum": [ - "Repository", - "Organization", - "Enterprise" - ] - }, - "source": { - "type": "string", - "description": "The name of the source" - }, - "enforcement": { - "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).", - "enum": [ - "disabled", - "active", - "evaluate" - ] - }, - "bypass_actors": { - "type": "array", - "description": "The actors that can bypass the rules in this ruleset", - "items": { - "title": "Repository Ruleset Bypass Actor", + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { "type": "object", - "description": "An actor that can bypass rules in a ruleset", - "required": [ - "actor_type" - ], "properties": { - "actor_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + "admin": { + "type": "boolean" }, - "actor_type": { - "type": "string", - "enum": [ - "Integration", - "OrganizationAdmin", - "RepositoryRole", - "Team", - "DeployKey" - ], - "description": "The type of actor that can bypass a ruleset." + "maintain": { + "type": "boolean" }, - "bypass_mode": { - "type": "string", - "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", - "enum": [ - "always", - "pull_request" - ], - "default": "always" - } - } - } - }, - "current_user_can_bypass": { - "type": "string", - "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", - "enum": [ - "always", - "pull_requests_only", - "never" - ] - }, - "node_id": { - "type": "string" - }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The URL of the ruleset" - } - } - }, - "html": { - "type": [ - "object", - "null" - ], - "properties": { - "href": { - "type": "string", - "description": "The html URL of the ruleset" - } - } - } - } - }, - "conditions": { - "anyOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" } - }, - { - "title": "Organization ruleset conditions", - "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", - "oneOf": [ - { - "type": "object", - "title": "repository_name_and_ref_name", - "description": "Conditions to target repositories by name and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository names", - "type": "object", - "description": "Parameters for a repository name condition", - "properties": { - "repository_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - }, - "protected": { - "type": "boolean", - "description": "Whether renaming of target repositories is prevented." - } - } - } - }, - "required": [ - "repository_name" - ] - } - ] - }, - { - "type": "object", - "title": "repository_id_and_ref_name", - "description": "Conditions to target repositories by id and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository IDs", - "type": "object", - "description": "Parameters for a repository ID condition", - "properties": { - "repository_id": { - "type": "object", - "properties": { - "repository_ids": { - "type": "array", - "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", - "items": { - "type": "integer" - } - } - } - } - }, - "required": [ - "repository_id" - ] - } - ] - }, - { - "type": "object", - "title": "repository_property_and_ref_name", - "description": "Conditions to target repositories by property and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository properties", - "type": "object", - "description": "Parameters for a repository property condition", - "properties": { - "repository_property": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - }, - "exclude": { - "type": "array", - "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - } - } - } - }, - "required": [ - "repository_property" - ] - } - ] - } - ] } - ], - "type": [ - "null", - "object" - ] - }, - "rules": { - "type": "array", - "items": { - "title": "Repository Rule", + }, + "role_name": { + "type": "string", + "examples": [ + "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", - "description": "A repository rule.", - "oneOf": [ - { - "title": "creation", - "description": "Only allow users with bypass permission to create matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "creation" - ] - } - } - }, - { - "title": "update", - "description": "Only allow users with bypass permission to update matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "update" - ] - }, - "parameters": { - "type": "object", - "properties": { - "update_allows_fetch_and_merge": { - "type": "boolean", - "description": "Branch can pull changes from its upstream repository" - } - }, - "required": [ - "update_allows_fetch_and_merge" - ] - } - } - }, - { - "title": "deletion", - "description": "Only allow users with bypass permissions to delete matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "deletion" - ] - } - } + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] }, - { - "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_linear_history" - ] - } - } + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] }, - { - "title": "merge_queue", - "description": "Merges must be performed via a merge queue.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "merge_queue" - ] - }, - "parameters": { - "type": "object", - "properties": { - "check_response_timeout_minutes": { - "type": "integer", - "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", - "minimum": 1, - "maximum": 360 - }, - "grouping_strategy": { - "type": "string", - "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", - "enum": [ - "ALLGREEN", - "HEADGREEN" - ] - }, - "max_entries_to_build": { - "type": "integer", - "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", - "minimum": 0, - "maximum": 100 - }, - "max_entries_to_merge": { - "type": "integer", - "description": "The maximum number of PRs that will be merged together in a group.", - "minimum": 0, - "maximum": 100 - }, - "merge_method": { - "type": "string", - "description": "Method to use when merging changes from queued pull requests.", - "enum": [ - "MERGE", - "SQUASH", - "REBASE" - ] - }, - "min_entries_to_merge": { - "type": "integer", - "description": "The minimum number of PRs that will be merged together in a group.", - "minimum": 0, - "maximum": 100 - }, - "min_entries_to_merge_wait_minutes": { - "type": "integer", - "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", - "minimum": 0, - "maximum": 360 - } - }, - "required": [ - "check_response_timeout_minutes", - "grouping_strategy", - "max_entries_to_build", - "max_entries_to_merge", - "merge_method", - "min_entries_to_merge", - "min_entries_to_merge_wait_minutes" - ] - } - } + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] }, - { - "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_deployments" - ] - }, - "parameters": { - "type": "object", - "properties": { - "required_deployment_environments": { - "type": "array", - "description": "The environments that must be successfully deployed to before branches can be merged.", - "items": { - "type": "string" - } - } - }, - "required": [ - "required_deployment_environments" - ] - } - } + "body": { + "type": "string", + "examples": [ + "# 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" + ] }, - { - "title": "required_signatures", - "description": "Commits pushed to matching refs must have verified signatures.", - "type": "object", - "required": [ - "type" + "html_url": { + "type": [ + "string", + "null" ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_signatures" - ] - } - } + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" }, - { - "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.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "pull_request" - ] - }, - "parameters": { - "type": "object", - "properties": { - "allowed_merge_methods": { - "type": "array", - "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", - "items": { - "type": "string", - "enum": [ - "merge", - "squash", - "rebase" - ] - } - }, - "automatic_copilot_code_review_enabled": { - "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean", - "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." - }, - "require_code_owner_review": { - "type": "boolean", - "description": "Require an approving review in pull requests that modify files that have a designated code owner." - }, - "require_last_push_approval": { - "type": "boolean", - "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." - }, - "required_approving_review_count": { - "type": "integer", - "description": "The number of approving reviews that are required before a pull request can be merged.", - "minimum": 0, - "maximum": 10 - }, - "required_review_thread_resolution": { - "type": "boolean", - "description": "All conversations on code must be resolved before a pull request can be merged." - } - }, - "required": [ - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "require_last_push_approval", - "required_approving_review_count", - "required_review_thread_resolution" - ] - } - } + "name": { + "type": "string" }, - { - "title": "required_status_checks", - "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_status_checks" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "required_status_checks": { - "type": "array", - "description": "Status checks that are required.", - "items": { - "title": "StatusCheckConfiguration", - "description": "Required status check", - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "The status check context name that must be present on the commit." - }, - "integration_id": { - "type": "integer", - "description": "The optional integration ID that this status check must originate from." - } - }, - "required": [ - "context" - ] - } - }, - "strict_required_status_checks_policy": { - "type": "boolean", - "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." - } - }, - "required": [ - "required_status_checks", - "strict_required_status_checks_policy" - ] - } - } + "spdx_id": { + "type": "string" }, - { - "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "non_fast_forward" - ] - } - } + "url": { + "type": "string" }, - { - "title": "commit_message_pattern", - "description": "Parameters to be used for the commit_message_pattern rule", + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "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", - "required": [ - "type" - ], "properties": { - "type": { + "status": { "type": "string", "enum": [ - "commit_message_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" + "enabled", + "disabled" ] } } }, - { - "title": "commit_author_email_pattern", - "description": "Parameters to be used for the commit_author_email_pattern rule", + "code_security": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { + "status": { "type": "string", "enum": [ - "commit_author_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" + "enabled", + "disabled" ] } } }, - { - "title": "committer_email_pattern", - "description": "Parameters to be used for the committer_email_pattern rule", + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", "type": "object", - "required": [ - "type" - ], "properties": { - "type": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", "type": "string", "enum": [ - "committer_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" + "enabled", + "disabled" ] } } }, - { - "title": "branch_name_pattern", - "description": "Parameters to be used for the branch_name_pattern rule", + "secret_scanning": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { + "status": { "type": "string", "enum": [ - "branch_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" + "enabled", + "disabled" ] } } }, - { - "title": "tag_name_pattern", - "description": "Parameters to be used for the tag_name_pattern rule", + "secret_scanning_push_protection": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { + "status": { "type": "string", "enum": [ - "tag_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" + "enabled", + "disabled" ] } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "secret_scanning_non_provider_patterns": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { + "status": { "type": "string", "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" + "enabled", + "disabled" ] } } }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "secret_scanning_ai_detection": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { + "status": { "type": "string", "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" + "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 } }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } + "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, - "name": "super cool ruleset", - "target": "branch", - "source_type": "Organization", - "source": "my-org", - "enforcement": "active", - "bypass_actors": [ - { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" - } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" - ], - "exclude": [ - "refs/heads/dev*" - ] + "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 }, - "repository_name": { - "include": [ - "important_repository", - "another_important_repository" - ], - "exclude": [ - "unimportant_repository" - ], - "protected": true - } - }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } - } - ], - "node_id": "RRS_lACkVXNlcgQB", - "_links": { - "self": { - "href": "https://api.github.com/orgs/my-org/rulesets/21" + "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": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "has_discussions": false, + "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 }, - "html": { - "href": "https://github.com/organizations/my-org/settings/rules/21" + "security_and_analysis": { + "advanced_security": { + "status": "enabled" + }, + "secret_scanning": { + "status": "enabled" + }, + "secret_scanning_push_protection": { + "status": "disabled" + }, + "secret_scanning_non_provider_patterns": { + "status": "disabled" + } } - }, - "created_at": "2023-08-15T08:43:03Z", - "updated_at": "2023-09-23T16:29:47Z" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } + } + ] } } } - } - }, - "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" } } } } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" } - } - }, - "/orgs/{org}/rulesets/rule-suites": { - "get": { - "summary": "List organization rule suites", - "description": "Lists suites of rule evaluations at the organization level.\nFor more information, see \"[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets).\"", + }, + "post": { + "summary": "Create an organization repository", + "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.", "tags": [ "repos" ], - "operationId": "repos/get-org-rule-suites", + "operationId": "repos/create-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites" + "url": "https://docs.github.com/rest/repos/repos#create-an-organization-repository" }, "parameters": [ { @@ -152588,4900 +146883,4810 @@ "schema": { "type": "string" } - }, - { - "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 to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned.", - "in": "query", - "schema": { - "type": "string" - }, - "x-multi-segment": true - }, - { - "name": "repository_name", - "description": "The name of the repository to filter on.", - "in": "query", - "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": "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" - } - }, - { - "name": "rule_suite_result", - "description": "The rule suite results to filter on. When specified, only suites with this result will be returned.", - "in": "query", - "schema": { - "type": "string", - "enum": [ - "pass", - "fail", - "bypass", - "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", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } } ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Rule Suites", - "description": "Response", - "type": "array", - "items": { + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository." + }, + "description": { + "type": "string", + "description": "A short description of the repository." + }, + "homepage": { + "type": "string", + "description": "A URL with more information about the repository." + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private.", + "default": false + }, + "visibility": { + "type": "string", + "description": "The visibility of the repository.", + "enum": [ + "public", + "private" + ] + }, + "has_issues": { + "type": "boolean", + "description": "Either `true` to enable issues for this repository or `false` to disable them.", + "default": true + }, + "has_projects": { + "type": "boolean", + "description": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", + "default": true + }, + "has_wiki": { + "type": "boolean", + "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", + "default": true + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "is_template": { + "type": "boolean", + "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", + "default": false + }, + "team_id": { + "type": "integer", + "description": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization." + }, + "auto_init": { + "type": "boolean", + "description": "Pass `true` to create an initial commit with empty README.", + "default": false + }, + "gitignore_template": { + "type": "string", + "description": "Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, \"Haskell\"." + }, + "license_template": { + "type": "string", + "description": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\"." + }, + "allow_squash_merge": { + "type": "boolean", + "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", + "default": true + }, + "allow_merge_commit": { + "type": "boolean", + "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", + "default": true + }, + "allow_rebase_merge": { + "type": "boolean", + "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", + "default": true + }, + "allow_auto_merge": { + "type": "boolean", + "description": "Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge.", + "default": false + }, + "delete_branch_on_merge": { + "type": "boolean", + "description": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. **The authenticated user must be an organization owner to set this property to `true`.**", + "default": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **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": "Required when using `squash_merge_commit_message`.\n\nThe 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": "Required when using `merge_commit_message`.\n\nThe 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." + }, + "custom_properties": { "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the rule insight." - }, - "actor_id": { - "type": "integer", - "description": "The number that identifies the user." - }, - "actor_name": { - "type": "string", - "description": "The handle for the GitHub user account." - }, - "before_sha": { - "type": "string", - "description": "The first commit sha before the push evaluation." - }, - "after_sha": { - "type": "string", - "description": "The last commit sha in the push evaluation." - }, - "ref": { - "type": "string", - "description": "The ref name that the evaluation ran on." - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository associated with the rule evaluation." - }, - "repository_name": { - "type": "string", - "description": "The name of the repository without the `.git` extension." - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "result": { - "type": "string", - "enum": [ - "pass", - "fail", - "bypass" - ], - "description": "The result of the rule evaluations for rules with the `active` enforcement status." - }, - "evaluation_result": { - "type": "string", - "enum": [ - "pass", - "fail", - "bypass" - ], - "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`." - } - } + "description": "The custom properties for the new repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, - "examples": { - "default": { - "value": [ - { - "id": 21, - "actor_id": 12, - "actor_name": "octocat", - "before_sha": "893f768e172fb1bc9c5d6f3dd48557e45f14e01d", - "after_sha": "dedd88641a362b6b4ea872da4847d6131a164d01", - "ref": "refs/heads/i-see-everything", - "repository_id": 404, - "repository_name": "octo-repo", - "pushed_at": "2023-07-06T08:43:03Z", - "result": "bypass" - }, - { - "id": 25, - "actor_id": 11, - "actor_name": "not-octocat", - "before_sha": "48994e4e01ccc943624c6231f172702b82b233cc", - "after_sha": "ecfd5a1025fa271a33ca5608d089476a2df3c9a1", - "ref": "refs/heads/i-am-everything", - "repository_id": 404, - "repository_name": "octo-repo", - "pushed_at": "2023-07-07T08:43:03Z", - "result": "pass", - "evaluation_result": "fail" - } - ] - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "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" - } + "required": [ + "name" + ] + }, + "examples": { + "default": { + "value": { + "name": "Hello-World", + "description": "This is your first repository", + "homepage": "https://github.com", + "private": false, + "has_issues": true, + "has_projects": true, + "has_wiki": true } } } } } }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "rule-suites" - } - } - }, - "/orgs/{org}/rulesets/rule-suites/{rule_suite_id}": { - "get": { - "summary": "Get an organization rule suite", - "description": "Gets information about a suite of rule evaluations from within an organization.\nFor more information, see \"[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets).\"", - "tags": [ - "repos" - ], - "operationId": "repos/get-org-rule-suite", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "rule_suite_id", - "description": "The unique identifier of the rule suite result.\nTo get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites)\nfor repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites)\nfor organizations.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], "responses": { - "200": { + "201": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Rule Suite", - "description": "Response", + "title": "Full Repository", + "description": "Full Repository", "type": "object", "properties": { "id": { "type": "integer", - "description": "The unique identifier of the rule insight." + "format": "int64", + "examples": [ + 1296269 + ] }, - "actor_id": { - "type": [ - "integer", - "null" - ], - "description": "The number that identifies the user." + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] }, - "actor_name": { + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { "type": [ "string", "null" ], - "description": "The handle for the GitHub user account." + "examples": [ + "This your first repo!" + ] }, - "before_sha": { + "fork": { + "type": "boolean" + }, + "url": { "type": "string", - "description": "The first commit sha before the push evaluation." + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] }, - "after_sha": { + "archive_url": { "type": "string", - "description": "The last commit sha in the push evaluation." + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] }, - "ref": { + "assignees_url": { "type": "string", - "description": "The ref name that the evaluation ran on." + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository associated with the rule evaluation." + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] }, - "repository_name": { + "branches_url": { "type": "string", - "description": "The name of the repository without the `.git` extension." + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] }, - "pushed_at": { + "collaborators_url": { "type": "string", - "format": "date-time", "examples": [ - "2011-01-26T19:06:43Z" + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, - "result": { + "comments_url": { "type": "string", - "enum": [ - "pass", - "fail", - "bypass" - ], - "description": "The result of the rule evaluations for rules with the `active` enforcement status." + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] }, - "evaluation_result": { - "type": [ - "string", - "null" - ], - "enum": [ - "pass", - "fail", - "bypass", - null - ], - "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. Null if no rules with `evaluate` enforcement status were run." + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] }, - "rule_evaluations": { - "type": "array", - "description": "Details on the evaluated rules.", - "items": { - "type": "object", - "properties": { - "rule_source": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of rule source." - }, - "id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the rule source." - }, - "name": { - "type": [ - "string", - "null" - ], - "description": "The name of the rule source." - } - } - }, - "enforcement": { - "type": "string", - "enum": [ - "active", - "evaluate", - "deleted ruleset" - ], - "description": "The enforcement level of this rule source." - }, - "result": { - "type": "string", - "enum": [ - "pass", - "fail" - ], - "description": "The result of the evaluation of the individual rule." - }, - "rule_type": { - "type": "string", - "description": "The type of rule." - }, - "details": { - "type": [ - "string", - "null" - ], - "description": "The detailed failure message for the rule. Null if the rule passed." - } - } - } - } - } - }, - "examples": { - "default": { - "value": { - "id": 21, - "actor_id": 12, - "actor_name": "octocat", - "before_sha": "893f768e172fb1bc9c5d6f3dd48557e45f14e01d", - "after_sha": "dedd88641a362b6b4ea872da4847d6131a164d01", - "ref": "refs/heads/i-see-everything", - "repository_id": 404, - "repository_name": "octo-repo", - "pushed_at": "2023-07-06T08:43:03Z", - "result": "bypass", - "evaluation_result": "fail", - "rule_evaluations": [ - { - "rule_source": { - "type": "ruleset", - "id": 2, - "name": "Author email must be a GitHub email address" - }, - "enforcement": "active", - "result": "pass", - "rule_type": "commit_author_email_pattern" - }, - { - "rule_source": { - "type": "protected_branch" - }, - "enforcement": "active", - "result": "fail", - "rule_type": "pull_request", - "details": "Changes must be made through a pull request." - }, - { - "rule_source": { - "type": "ruleset", - "id": 3, - "name": "Evaluate commit message pattern" - }, - "enforcement": "evaluate", - "result": "fail", - "rule_type": "commit_message_pattern" - } + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" }, - "documentation_url": { - "type": "string" + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] }, - "url": { - "type": "string" + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] }, - "documentation_url": { - "type": "string" + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] }, - "url": { - "type": "string" + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "rule-suites" - } - } - }, - "/orgs/{org}/rulesets/{ruleset_id}": { - "get": { - "summary": "Get an organization repository ruleset", - "description": "Get a repository ruleset for an organization.\n\n**Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user\nmaking the API request has write access to the ruleset.", - "tags": [ - "repos" - ], - "operationId": "repos/get-org-ruleset", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/rules#get-an-organization-repository-ruleset" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "rules" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "ruleset_id", - "description": "The ID of the ruleset.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Repository ruleset", - "type": "object", - "description": "A set of rules to apply when specified conditions are met.", - "required": [ - "id", - "name", - "source", - "enforcement" - ], - "properties": { - "id": { - "type": "integer", - "description": "The ID of the ruleset" + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] }, - "name": { + "git_commits_url": { "type": "string", - "description": "The name of the ruleset" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] }, - "target": { + "git_refs_url": { "type": "string", - "description": "The target of the ruleset", - "enum": [ - "branch", - "tag", - "push", - "repository" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, - "source_type": { + "git_tags_url": { "type": "string", - "description": "The type of the source of the ruleset", - "enum": [ - "Repository", - "Organization", - "Enterprise" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, - "source": { + "git_url": { "type": "string", - "description": "The name of the source" + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] }, - "enforcement": { + "issue_comment_url": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).", - "enum": [ - "disabled", - "active", - "evaluate" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, - "bypass_actors": { + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { "type": "array", - "description": "The actors that can bypass the rules in this ruleset", "items": { - "title": "Repository Ruleset Bypass Actor", - "type": "object", - "description": "An actor that can bypass rules in a ruleset", - "required": [ - "actor_type" - ], - "properties": { - "actor_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." - }, - "actor_type": { - "type": "string", - "enum": [ - "Integration", - "OrganizationAdmin", - "RepositoryRole", - "Team", - "DeployKey" - ], - "description": "The type of actor that can bypass a ruleset." - }, - "bypass_mode": { - "type": "string", - "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", - "enum": [ - "always", - "pull_request" - ], - "default": "always" - } - } - } + "type": "string" + }, + "examples": [ + "octocat", + "atom", + "electron", + "API" + ] }, - "current_user_can_bypass": { + "has_issues": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", "type": "string", - "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", - "enum": [ - "always", - "pull_requests_only", - "never" + "examples": [ + "public" ] }, - "node_id": { - "type": "string" + "pushed_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] }, - "_links": { + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { "type": "object", "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The URL of the ruleset" - } - } + "admin": { + "type": "boolean" }, - "html": { - "type": [ - "object", - "null" - ], - "properties": { - "href": { - "type": "string", - "description": "The html URL of the ruleset" - } - } + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" } - } + }, + "required": [ + "admin", + "pull", + "push" + ] }, - "conditions": { + "allow_rebase_merge": { + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { "anyOf": [ { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } + "type": "null" }, { - "title": "Organization ruleset conditions", + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", - "oneOf": [ - { - "type": "object", - "title": "repository_name_and_ref_name", - "description": "Conditions to target repositories by name and refs by name", - "allOf": [ + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } + "type": "null" }, { - "title": "Repository ruleset conditions for repository names", + "title": "License Simple", + "description": "License Simple", "type": "object", - "description": "Parameters for a repository name condition", "properties": { - "repository_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - }, - "protected": { - "type": "boolean", - "description": "Whether renaming of target repositories is prevented." - } - } + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" } }, "required": [ - "repository_name" + "key", + "name", + "url", + "spdx_id", + "node_id" ] } ] }, - { + "forks": { + "type": "integer" + }, + "permissions": { "type": "object", - "title": "repository_id_and_ref_name", - "description": "Conditions to target repositories by id and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } + "properties": { + "admin": { + "type": "boolean" }, - { - "title": "Repository ruleset conditions for repository IDs", - "type": "object", - "description": "Parameters for a repository ID condition", - "properties": { - "repository_id": { - "type": "object", - "properties": { - "repository_ids": { - "type": "array", - "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", - "items": { - "type": "integer" - } - } - } - } - }, - "required": [ - "repository_id" - ] + "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", - "title": "repository_property_and_ref_name", - "description": "Conditions to target repositories by property and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - { - "title": "Repository ruleset conditions for repository properties", - "type": "object", - "description": "Parameters for a repository property condition", - "properties": { - "repository_property": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - }, - "exclude": { - "type": "array", - "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - } - } - } - }, - "required": [ - "repository_property" + "email": { + "type": [ + "string", + "null" ] - } - ] - } - ] - } - ], - "type": [ - "null", - "object" - ] - }, - "rules": { - "type": "array", - "items": { - "title": "Repository Rule", - "type": "object", - "description": "A repository rule.", - "oneOf": [ - { - "title": "creation", - "description": "Only allow users with bypass permission to create matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "creation" - ] - } - } - }, - { - "title": "update", - "description": "Only allow users with bypass permission to update matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "update" - ] - }, - "parameters": { - "type": "object", - "properties": { - "update_allows_fetch_and_merge": { - "type": "boolean", - "description": "Branch can pull changes from its upstream repository" - } }, - "required": [ - "update_allows_fetch_and_merge" - ] - } - } - }, - { - "title": "deletion", - "description": "Only allow users with bypass permissions to delete matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "deletion" - ] - } - } - }, - { - "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_linear_history" - ] - } - } - }, - { - "title": "merge_queue", - "description": "Merges must be performed via a merge queue.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "merge_queue" - ] - }, - "parameters": { - "type": "object", - "properties": { - "check_response_timeout_minutes": { - "type": "integer", - "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", - "minimum": 1, - "maximum": 360 - }, - "grouping_strategy": { - "type": "string", - "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", - "enum": [ - "ALLGREEN", - "HEADGREEN" - ] - }, - "max_entries_to_build": { - "type": "integer", - "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", - "minimum": 0, - "maximum": 100 - }, - "max_entries_to_merge": { - "type": "integer", - "description": "The maximum number of PRs that will be merged together in a group.", - "minimum": 0, - "maximum": 100 - }, - "merge_method": { - "type": "string", - "description": "Method to use when merging changes from queued pull requests.", - "enum": [ - "MERGE", - "SQUASH", - "REBASE" - ] - }, - "min_entries_to_merge": { - "type": "integer", - "description": "The minimum number of PRs that will be merged together in a group.", - "minimum": 0, - "maximum": 100 - }, - "min_entries_to_merge_wait_minutes": { - "type": "integer", - "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", - "minimum": 0, - "maximum": 360 - } + "login": { + "type": "string", + "examples": [ + "octocat" + ] }, - "required": [ - "check_response_timeout_minutes", - "grouping_strategy", - "max_entries_to_build", - "max_entries_to_merge", - "merge_method", - "min_entries_to_merge", - "min_entries_to_merge_wait_minutes" - ] - } - } - }, - { - "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_deployments" - ] - }, - "parameters": { - "type": "object", - "properties": { - "required_deployment_environments": { - "type": "array", - "description": "The environments that must be successfully deployed to before branches can be merged.", - "items": { - "type": "string" - } - } + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] }, - "required": [ - "required_deployment_environments" - ] - } - } - }, - { - "title": "required_signatures", - "description": "Commits pushed to matching refs must have verified signatures.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_signatures" - ] - } - } - }, - { - "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.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "pull_request" - ] - }, - "parameters": { - "type": "object", - "properties": { - "allowed_merge_methods": { - "type": "array", - "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", - "items": { - "type": "string", - "enum": [ - "merge", - "squash", - "rebase" - ] - } - }, - "automatic_copilot_code_review_enabled": { - "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean", - "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." - }, - "require_code_owner_review": { - "type": "boolean", - "description": "Require an approving review in pull requests that modify files that have a designated code owner." - }, - "require_last_push_approval": { - "type": "boolean", - "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." - }, - "required_approving_review_count": { - "type": "integer", - "description": "The number of approving reviews that are required before a pull request can be merged.", - "minimum": 0, - "maximum": 10 - }, - "required_review_thread_resolution": { - "type": "boolean", - "description": "All conversations on code must be resolved before a pull request can be merged." - } + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] }, - "required": [ - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "require_last_push_approval", - "required_approving_review_count", - "required_review_thread_resolution" - ] - } - } - }, - { - "title": "required_status_checks", - "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_status_checks" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "required_status_checks": { - "type": "array", - "description": "Status checks that are required.", - "items": { - "title": "StatusCheckConfiguration", - "description": "Required status check", - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "The status check context name that must be present on the commit." - }, - "integration_id": { - "type": "integer", - "description": "The optional integration ID that this status check must originate from." - } - }, - "required": [ - "context" - ] - } - }, - "strict_required_status_checks_policy": { - "type": "boolean", - "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." - } + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, - "required": [ - "required_status_checks", - "strict_required_status_checks_policy" - ] - } - } - }, - { - "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "non_fast_forward" - ] - } - } - }, - { - "title": "commit_message_pattern", - "description": "Parameters to be used for the commit_message_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_message_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "commit_author_email_pattern", - "description": "Parameters to be used for the commit_author_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_author_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "committer_email_pattern", - "description": "Parameters to be used for the committer_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "committer_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "branch_name_pattern", - "description": "Parameters to be used for the branch_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "branch_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "tag_name_pattern", - "description": "Parameters to be used for the tag_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tag_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] }, - "required": [ - "max_file_size" - ] - } - } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] }, - "required": [ - "code_scanning_tools" - ] - } - } - } - ] - } - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - }, - "examples": { - "default": { - "value": { - "id": 21, - "name": "super cool ruleset", - "target": "branch", - "source_type": "Organization", - "source": "my-org", - "enforcement": "active", - "bypass_actors": [ - { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" - } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" - ], - "exclude": [ - "refs/heads/dev*" - ] - }, - "repository_name": { - "include": [ - "important_repository", - "another_important_repository" - ], - "exclude": [ - "unimportant_repository" - ], - "protected": true - } - }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } - } - ], - "node_id": "RRS_lACkVXNlcgQB", - "_links": { - "self": { - "href": "https://api.github.com/orgs/my-org/rulesets/21" - }, - "html": { - "href": "https://github.com/organizations/my-org/settings/rules/21" - } - }, - "created_at": "2023-08-15T08:43:03Z", - "updated_at": "2023-09-23T16:29:47Z" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "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" - } - } - } - } - } - } - } - }, - "put": { - "summary": "Update an organization repository ruleset", - "description": "Update a ruleset for an organization.", - "tags": [ - "repos" - ], - "operationId": "repos/update-org-ruleset", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/rules#update-an-organization-repository-ruleset" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "rules" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "ruleset_id", - "description": "The ID of the ruleset.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "description": "Request body", - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the ruleset." - }, - "target": { - "type": "string", - "description": "The target of the ruleset", - "enum": [ - "branch", - "tag", - "push", - "repository" - ] - }, - "enforcement": { - "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).", - "enum": [ - "disabled", - "active", - "evaluate" - ] - }, - "bypass_actors": { - "type": "array", - "description": "The actors that can bypass the rules in this ruleset", - "items": { - "title": "Repository Ruleset Bypass Actor", - "type": "object", - "description": "An actor that can bypass rules in a ruleset", - "required": [ - "actor_type" - ], - "properties": { - "actor_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." - }, - "actor_type": { - "type": "string", - "enum": [ - "Integration", - "OrganizationAdmin", - "RepositoryRole", - "Team", - "DeployKey" - ], - "description": "The type of actor that can bypass a ruleset." - }, - "bypass_mode": { - "type": "string", - "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", - "enum": [ - "always", - "pull_request" - ], - "default": "always" - } - } - } - }, - "conditions": { - "title": "Organization ruleset conditions", - "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", - "oneOf": [ - { - "type": "object", - "title": "repository_name_and_ref_name", - "description": "Conditions to target repositories by name and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository names", - "type": "object", - "description": "Parameters for a repository name condition", - "properties": { - "repository_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - }, - "protected": { - "type": "boolean", - "description": "Whether renaming of target repositories is prevented." - } - } - } - }, - "required": [ - "repository_name" - ] - } - ] - }, - { - "type": "object", - "title": "repository_id_and_ref_name", - "description": "Conditions to target repositories by id and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository IDs", - "type": "object", - "description": "Parameters for a repository ID condition", - "properties": { - "repository_id": { - "type": "object", - "properties": { - "repository_ids": { - "type": "array", - "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", - "items": { - "type": "integer" - } - } + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, - "required": [ - "repository_id" - ] - } - ] - }, - { - "type": "object", - "title": "repository_property_and_ref_name", - "description": "Conditions to target repositories by property and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository properties", - "type": "object", - "description": "Parameters for a repository property condition", - "properties": { - "repository_property": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - }, - "exclude": { - "type": "array", - "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - } - } - } + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" }, - "required": [ - "repository_property" - ] - } - ] - } - ] - }, - "rules": { - "description": "An array of rules within the ruleset.", - "type": "array", - "items": { - "title": "Repository Rule", - "type": "object", - "description": "A repository rule.", - "oneOf": [ - { - "title": "creation", - "description": "Only allow users with bypass permission to create matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + "html_url": { "type": "string", - "enum": [ - "creation" + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" ] - } - } - }, - { - "title": "update", - "description": "Only allow users with bypass permission to update matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { "type": "string", - "enum": [ - "update" + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" ] }, - "parameters": { - "type": "object", - "properties": { - "update_allows_fetch_and_merge": { - "type": "boolean", - "description": "Branch can pull changes from its upstream repository" - } - }, - "required": [ - "update_allows_fetch_and_merge" + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] - } - } - }, - { - "title": "deletion", - "description": "Only allow users with bypass permissions to delete matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "assignees_url": { "type": "string", - "enum": [ - "deletion" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] - } - } - }, - { - "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "blobs_url": { "type": "string", - "enum": [ - "required_linear_history" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] - } - } - }, - { - "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "branches_url": { "type": "string", - "enum": [ - "required_deployments" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, - "parameters": { - "type": "object", - "properties": { - "required_deployment_environments": { - "type": "array", - "description": "The environments that must be successfully deployed to before branches can be merged.", - "items": { - "type": "string" - } - } - }, - "required": [ - "required_deployment_environments" + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] - } - } - }, - { - "title": "required_signatures", - "description": "Commits pushed to matching refs must have verified signatures.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "comments_url": { "type": "string", - "enum": [ - "required_signatures" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] - } - } - }, - { - "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.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "commits_url": { "type": "string", - "enum": [ - "pull_request" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, - "parameters": { - "type": "object", - "properties": { - "allowed_merge_methods": { - "type": "array", - "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", - "items": { - "type": "string", - "enum": [ - "merge", - "squash", - "rebase" - ] - } - }, - "automatic_copilot_code_review_enabled": { - "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean", - "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." - }, - "require_code_owner_review": { - "type": "boolean", - "description": "Require an approving review in pull requests that modify files that have a designated code owner." - }, - "require_last_push_approval": { - "type": "boolean", - "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." - }, - "required_approving_review_count": { - "type": "integer", - "description": "The number of approving reviews that are required before a pull request can be merged.", - "minimum": 0, - "maximum": 10 - }, - "required_review_thread_resolution": { - "type": "boolean", - "description": "All conversations on code must be resolved before a pull request can be merged." - } - }, - "required": [ - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "require_last_push_approval", - "required_approving_review_count", - "required_review_thread_resolution" + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] - } - } - }, - { - "title": "required_status_checks", - "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "contents_url": { "type": "string", - "enum": [ - "required_status_checks" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "required_status_checks": { - "type": "array", - "description": "Status checks that are required.", - "items": { - "title": "StatusCheckConfiguration", - "description": "Required status check", - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "The status check context name that must be present on the commit." - }, - "integration_id": { - "type": "integer", - "description": "The optional integration ID that this status check must originate from." - } - }, - "required": [ - "context" - ] - } - }, - "strict_required_status_checks_policy": { - "type": "boolean", - "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." - } - }, - "required": [ - "required_status_checks", - "strict_required_status_checks_policy" + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" ] - } - } - }, - { - "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "deployments_url": { "type": "string", - "enum": [ - "non_fast_forward" + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" ] - } - } - }, - { - "title": "commit_message_pattern", - "description": "Parameters to be used for the commit_message_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "downloads_url": { "type": "string", - "enum": [ - "commit_message_pattern" + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" ] - } - } - }, - { - "title": "commit_author_email_pattern", - "description": "Parameters to be used for the commit_author_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "forks_url": { "type": "string", - "enum": [ - "commit_author_email_pattern" + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" ] }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] - } - } - }, - { - "title": "committer_email_pattern", - "description": "Parameters to be used for the committer_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "git_refs_url": { "type": "string", - "enum": [ - "committer_email_pattern" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] - } - } - }, - { - "title": "branch_name_pattern", - "description": "Parameters to be used for the branch_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "git_url": { "type": "string", - "enum": [ - "branch_name_pattern" + "examples": [ + "git:github.com/octocat/Hello-World.git" ] }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] - } - } - }, - { - "title": "tag_name_pattern", - "description": "Parameters to be used for the tag_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "issue_events_url": { "type": "string", - "enum": [ - "tag_name_pattern" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] - } - } - }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "keys_url": { "type": "string", - "enum": [ - "file_path_restriction" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "languages_url": { "type": "string", - "enum": [ - "max_file_path_length" + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" ] }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "milestones_url": { "type": "string", - "enum": [ - "file_extension_restriction" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "pulls_url": { "type": "string", - "enum": [ - "max_file_size" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] - } - } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "ssh_url": { "type": "string", - "enum": [ - "workflows" + "examples": [ + "git@github.com:octocat/Hello-World.git" ] }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { "type": "string", "enum": [ - "code_scanning" + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true ] }, - "parameters": { + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { "type": "object", + "description": "The status of the code search index for this repository", "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" } - }, - "required": [ - "code_scanning_tools" - ] + } } - } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] } ] - } - } - } - }, - "examples": { - "default": { - "value": { - "name": "super cool ruleset", - "target": "branch", - "enforcement": "active", - "bypass_actors": [ - { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" - } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" - ], - "exclude": [ - "refs/heads/dev*" - ] - }, - "repository_name": { - "include": [ - "important_repository", - "another_important_repository" - ], - "exclude": [ - "unimportant_repository" - ], - "protected": true - } }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Repository ruleset", - "type": "object", - "description": "A set of rules to apply when specified conditions are met.", - "required": [ - "id", - "name", - "source", - "enforcement" - ], - "properties": { - "id": { - "type": "integer", - "description": "The ID of the ruleset" + "temp_clone_token": { + "type": [ + "string", + "null" + ] }, - "name": { - "type": "string", - "description": "The name of the ruleset" + "allow_squash_merge": { + "type": "boolean", + "examples": [ + true + ] }, - "target": { + "allow_auto_merge": { + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "type": "boolean", + "examples": [ + false + ] + }, + "allow_merge_commit": { + "type": "boolean", + "examples": [ + true + ] + }, + "allow_update_branch": { + "type": "boolean", + "examples": [ + true + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "examples": [ + false + ] + }, + "squash_merge_commit_title": { "type": "string", - "description": "The target of the ruleset", "enum": [ - "branch", - "tag", - "push", - "repository" + "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).", + "examples": [ + "PR_TITLE" ] }, - "source_type": { + "squash_merge_commit_message": { "type": "string", - "description": "The type of the source of the ruleset", "enum": [ - "Repository", - "Organization", - "Enterprise" + "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.", + "examples": [ + "PR_BODY" ] }, - "source": { + "merge_commit_title": { "type": "string", - "description": "The name of the source" + "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).", + "examples": [ + "PR_TITLE" + ] }, - "enforcement": { + "merge_commit_message": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).", "enum": [ - "disabled", - "active", - "evaluate" + "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.", + "examples": [ + "PR_BODY" ] }, - "bypass_actors": { - "type": "array", - "description": "The actors that can bypass the rules in this ruleset", - "items": { - "title": "Repository Ruleset Bypass Actor", - "type": "object", - "description": "An actor that can bypass rules in a ruleset", - "required": [ - "actor_type" - ], - "properties": { - "actor_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." - }, - "actor_type": { - "type": "string", - "enum": [ - "Integration", - "OrganizationAdmin", - "RepositoryRole", - "Team", - "DeployKey" - ], - "description": "The type of actor that can bypass a ruleset." - }, - "bypass_mode": { - "type": "string", - "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", - "enum": [ - "always", - "pull_request" - ], - "default": "always" - } - } - } + "allow_forking": { + "type": "boolean", + "examples": [ + true + ] }, - "current_user_can_bypass": { - "type": "string", - "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", - "enum": [ - "always", - "pull_requests_only", - "never" + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false ] }, - "node_id": { - "type": "string" + "subscribers_count": { + "type": "integer", + "examples": [ + 42 + ] }, - "_links": { - "type": "object", - "properties": { - "self": { + "network_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", "type": "object", "properties": { - "href": { + "key": { "type": "string", - "description": "The URL of the ruleset" - } - } - }, - "html": { - "type": [ - "object", - "null" - ], - "properties": { - "href": { + "examples": [ + "mit" + ] + }, + "name": { "type": "string", - "description": "The html URL of the ruleset" + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" } - } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] } - } + ] }, - "conditions": { + "organization": { "anyOf": [ { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } + "type": "null" }, { - "title": "Organization ruleset conditions", + "title": "Simple User", + "description": "A GitHub user.", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", - "oneOf": [ - { - "type": "object", - "title": "repository_name_and_ref_name", - "description": "Conditions to target repositories by name and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository names", - "type": "object", - "description": "Parameters for a repository name condition", - "properties": { - "repository_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - }, - "protected": { - "type": "boolean", - "description": "Whether renaming of target repositories is prevented." - } - } - } - }, - "required": [ - "repository_name" - ] - } + "properties": { + "name": { + "type": [ + "string", + "null" ] }, - { - "type": "object", - "title": "repository_id_and_ref_name", - "description": "Conditions to target repositories by id and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository IDs", - "type": "object", - "description": "Parameters for a repository ID condition", - "properties": { - "repository_id": { - "type": "object", - "properties": { - "repository_ids": { - "type": "array", - "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", - "items": { - "type": "integer" - } - } - } - } - }, - "required": [ - "repository_id" - ] - } + "email": { + "type": [ + "string", + "null" ] }, - { - "type": "object", - "title": "repository_property_and_ref_name", - "description": "Conditions to target repositories by property and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository properties", - "type": "object", - "description": "Parameters for a repository property condition", - "properties": { - "repository_property": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - }, - "exclude": { - "type": "array", - "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - } - } - } - }, - "required": [ - "repository_property" - ] - } + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] } - ], - "type": [ - "null", - "object" ] }, - "rules": { - "type": "array", - "items": { - "title": "Repository Rule", - "type": "object", - "description": "A repository rule.", - "oneOf": [ - { - "title": "creation", - "description": "Only allow users with bypass permission to create matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "creation" - ] - } - } - }, - { - "title": "update", - "description": "Only allow users with bypass permission to update matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "update" - ] - }, - "parameters": { - "type": "object", - "properties": { - "update_allows_fetch_and_merge": { - "type": "boolean", - "description": "Branch can pull changes from its upstream repository" - } + "parent": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] }, - "required": [ - "update_allows_fetch_and_merge" - ] - } - } - }, - { - "title": "deletion", - "description": "Only allow users with bypass permissions to delete matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "deletion" - ] - } - } - }, - { - "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_linear_history" - ] - } - } - }, - { - "title": "merge_queue", - "description": "Merges must be performed via a merge queue.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "merge_queue" - ] - }, - "parameters": { - "type": "object", - "properties": { - "check_response_timeout_minutes": { - "type": "integer", - "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", - "minimum": 1, - "maximum": 360 - }, - "grouping_strategy": { - "type": "string", - "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", - "enum": [ - "ALLGREEN", - "HEADGREEN" - ] - }, - "max_entries_to_build": { - "type": "integer", - "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", - "minimum": 0, - "maximum": 100 - }, - "max_entries_to_merge": { - "type": "integer", - "description": "The maximum number of PRs that will be merged together in a group.", - "minimum": 0, - "maximum": 100 - }, - "merge_method": { - "type": "string", - "description": "Method to use when merging changes from queued pull requests.", - "enum": [ - "MERGE", - "SQUASH", - "REBASE" - ] - }, - "min_entries_to_merge": { - "type": "integer", - "description": "The minimum number of PRs that will be merged together in a group.", - "minimum": 0, - "maximum": 100 - }, - "min_entries_to_merge_wait_minutes": { - "type": "integer", - "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", - "minimum": 0, - "maximum": 360 - } + "name": { + "type": "string", + "examples": [ + "MIT License" + ] }, - "required": [ - "check_response_timeout_minutes", - "grouping_strategy", - "max_entries_to_build", - "max_entries_to_merge", - "merge_method", - "min_entries_to_merge", - "min_entries_to_merge_wait_minutes" - ] - } - } - }, - { - "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_deployments" - ] - }, - "parameters": { - "type": "object", - "properties": { - "required_deployment_environments": { - "type": "array", - "description": "The environments that must be successfully deployed to before branches can be merged.", - "items": { - "type": "string" - } - } + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] }, - "required": [ - "required_deployment_environments" - ] - } - } - }, - { - "title": "required_signatures", - "description": "Commits pushed to matching refs must have verified signatures.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_signatures" - ] - } - } - }, - { - "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.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "pull_request" - ] - }, - "parameters": { - "type": "object", - "properties": { - "allowed_merge_methods": { - "type": "array", - "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", - "items": { - "type": "string", - "enum": [ - "merge", - "squash", - "rebase" - ] - } - }, - "automatic_copilot_code_review_enabled": { - "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean", - "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." - }, - "require_code_owner_review": { - "type": "boolean", - "description": "Require an approving review in pull requests that modify files that have a designated code owner." - }, - "require_last_push_approval": { - "type": "boolean", - "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." - }, - "required_approving_review_count": { - "type": "integer", - "description": "The number of approving reviews that are required before a pull request can be merged.", - "minimum": 0, - "maximum": 10 - }, - "required_review_thread_resolution": { - "type": "boolean", - "description": "All conversations on code must be resolved before a pull request can be merged." - } + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] }, - "required": [ - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "require_last_push_approval", - "required_approving_review_count", - "required_review_thread_resolution" - ] - } - } - }, - { - "title": "required_status_checks", - "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_status_checks" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "required_status_checks": { - "type": "array", - "description": "Status checks that are required.", - "items": { - "title": "StatusCheckConfiguration", - "description": "Required status check", - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "The status check context name that must be present on the commit." - }, - "integration_id": { - "type": "integer", - "description": "The optional integration ID that this status check must originate from." - } - }, - "required": [ - "context" - ] - } - }, - "strict_required_status_checks_policy": { - "type": "boolean", - "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." - } + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] }, - "required": [ - "required_status_checks", - "strict_required_status_checks_policy" - ] - } - } - }, - { - "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "non_fast_forward" - ] - } - } - }, - { - "title": "commit_message_pattern", - "description": "Parameters to be used for the commit_message_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_message_pattern" - ] + "html_url": { + "type": "string", + "format": "uri" + } }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" } }, - { - "title": "commit_author_email_pattern", - "description": "Parameters to be used for the commit_author_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_author_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "committer_email_pattern", - "description": "Parameters to be used for the committer_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "committer_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "branch_name_pattern", - "description": "Parameters to be used for the branch_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "branch_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "tag_name_pattern", - "description": "Parameters to be used for the tag_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tag_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - } - ] - } - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - }, - "examples": { - "default": { - "value": { - "id": 21, - "name": "super cool ruleset", - "target": "branch", - "source_type": "Organization", - "source": "my-org", - "enforcement": "active", - "bypass_actors": [ - { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" - } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" ], - "exclude": [ - "refs/heads/dev*" + "examples": [ + "This your first repo!" ] }, - "repository_name": { - "include": [ - "important_repository", - "another_important_repository" + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" ], - "exclude": [ - "unimportant_repository" + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" ], - "protected": true - } - }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } - } - ], - "node_id": "RRS_lACkVXNlcgQB", - "_links": { - "self": { - "href": "https://api.github.com/orgs/my-org/rulesets/21" + "format": "uri", + "examples": [ + "https://github.com" + ] }, - "html": { - "href": "https://github.com/organizations/my-org/settings/rules/21" - } - }, - "created_at": "2023-08-15T08:43:03Z", - "updated_at": "2023-09-23T16:29:47Z" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "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" - } - } - } - } - } - } - } - }, - "delete": { - "summary": "Delete an organization repository ruleset", - "description": "Delete a ruleset for an organization.", - "tags": [ - "repos" - ], - "operationId": "repos/delete-org-ruleset", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/rules#delete-an-organization-repository-ruleset" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "rules" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "ruleset_id", - "description": "The ID of the ruleset.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "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" - } - } - } - } - } - }, - "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" - } - } - } - } - } - } - } - } - }, - "/orgs/{org}/rulesets/{ruleset_id}/history": { - "get": { - "summary": "Get organization ruleset history", - "description": "Get the history of an organization ruleset.", - "tags": [ - "orgs" - ], - "operationId": "orgs/get-org-ruleset-history", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/rules#get-organization-ruleset-history" - }, - "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": "ruleset_id", - "description": "The ID of the ruleset.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Ruleset version", - "type": "object", - "description": "The historical version of a ruleset", - "required": [ - "version_id", - "actor", - "updated_at" - ], - "properties": { - "version_id": { - "type": "integer", - "description": "The ID of the previous version of the ruleset" - }, - "actor": { - "type": "object", - "description": "The actor who updated the ruleset", - "properties": { - "id": { - "type": "integer" - }, - "type": { + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { "type": "string" } - } - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - } - }, - "examples": { - "default": { - "value": [ - { - "version_id": 3, - "actor": { - "id": 1, - "type": "User" }, - "updated_at": "2024-010-23T16:29:47Z" - }, - { - "version_id": 2, - "actor": { - "id": 2, - "type": "User" + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, - "updated_at": "2024-09-23T16:29:47Z" - }, - { - "version_id": 1, - "actor": { - "id": 1, - "type": "User" + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, - "updated_at": "2024-08-23T16:29:47Z" - } - ] - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "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": true, - "category": "orgs", - "subcategory": "rules" - } - } - }, - "/orgs/{org}/rulesets/{ruleset_id}/history/{version_id}": { - "get": { - "summary": "Get organization ruleset version", - "description": "Get a version of an organization ruleset.", - "tags": [ - "orgs" - ], - "operationId": "orgs/get-org-ruleset-version", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/rules#get-organization-ruleset-version" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "ruleset_id", - "description": "The ID of the ruleset.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "version_id", - "description": "The ID of the version", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "title": "Ruleset version", - "type": "object", - "description": "The historical version of a ruleset", - "required": [ - "version_id", - "actor", - "updated_at" - ], - "properties": { - "version_id": { - "type": "integer", - "description": "The ID of the previous version of the ruleset" + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, - "actor": { + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { "type": "object", - "description": "The actor who updated the ruleset", + "description": "The status of the code search index for this repository", "properties": { - "id": { - "type": "integer" + "lexical_search_ok": { + "type": "boolean" }, - "type": { + "lexical_commit_sha": { "type": "string" } } - }, - "updated_at": { - "type": "string", - "format": "date-time" } - } + }, + "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" + ] }, - { + "source": { + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", - "required": [ - "state" - ], "properties": { - "state": { - "type": "object", - "description": "The state of the ruleset version" - } - } - } - ] - }, - "examples": { - "default": { - "value": [ - { - "version_id": 3, - "actor": { - "id": 1, - "type": "User" + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] }, - "updated_at": "2024-010-23T16:29:47Z", - "state": { - "id": 21, - "name": "super cool ruleset", - "target": "branch", - "source_type": "Organization", - "source": "my-org", - "enforcement": "active", - "bypass_actors": [ + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" - ], - "exclude": [ - "refs/heads/dev*" + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" ] }, - "repository_name": { - "include": [ - "important_repository", - "another_important_repository" - ], - "exclude": [ - "unimportant_repository" + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" ], - "protected": true + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } - } + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] - } - } - ] - } + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "forks": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "anonymous_access_enabled": { + "description": "Whether anonymous git access is allowed.", + "default": true, + "type": "boolean" + }, + "code_of_conduct": { + "title": "Code Of Conduct Simple", + "description": "Code of Conduct Simple", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/github/docs/community/code_of_conduct" + ] + }, + "key": { + "type": "string", + "examples": [ + "citizen_code_of_conduct" + ] + }, + "name": { + "type": "string", + "examples": [ + "Citizen Code of Conduct" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md" + ] + } + }, + "required": [ + "url", + "key", + "name", + "html_url" + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "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", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "has_discussions", + "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", + "network_count", + "subscribers_count" + ] + }, + "examples": { + "default": { + "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}", + "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", + "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" + }, + "language": null, + "forks_count": 9, + "forks": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "open_issues": 0, + "is_template": false, + "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": { + "pull": true, + "push": false, + "admin": false + }, + "allow_rebase_merge": true, + "template_repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World-Template", + "full_name": "octocat/Hello-World-Template", + "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-Template", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World-Template", + "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World-Template.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World-Template.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World-Template.git", + "mirror_url": "git:git.example.com/octocat/Hello-World-Template", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World-Template", + "homepage": "https://github.com", + "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, + "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", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "allow_forking": true, + "web_commit_signoff_required": false, + "subscribers_count": 42, + "network_count": 0, + "organization": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "Organization", + "site_admin": false + }, + "parent": { + "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, + "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://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + }, + "source": { + "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, + "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://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + } + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World", + "schema": { + "type": "string" } } } }, - "404": { - "description": "Resource not found", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -157506,14 +151711,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" @@ -157521,11 +151730,56 @@ "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } } } } @@ -157536,22 +151790,28 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "rules" + "category": "repos", + "subcategory": "repos" } } }, - "/orgs/{org}/secret-scanning/alerts": { + "/orgs/{org}/rulesets": { "get": { - "summary": "List secret scanning alerts for an organization", - "description": "Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.\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 `repo` or `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": "Get all organization repository rulesets", + "description": "Get all the repository rulesets for an organization.", "tags": [ - "secret-scanning" + "repos" ], - "operationId": "secret-scanning/list-alerts-for-org", + "operationId": "repos/get-org-rulesets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization" + "url": "https://docs.github.com/rest/orgs/rules#get-all-organization-repository-rulesets" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "rules" }, "parameters": [ { @@ -157563,74 +151823,6 @@ "type": "string" } }, - { - "name": "state", - "in": "query", - "description": "Set to `open` or `resolved` to only list secret scanning alerts in a specific state.", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "resolved" - ] - } - }, - { - "name": "secret_type", - "in": "query", - "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "resolution", - "in": "query", - "description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.", - "required": false, - "schema": { - "type": "string" - } - }, - { - "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.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated" - ], - "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": "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).\"", @@ -157641,60 +151833,24 @@ } }, { - "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 receive an initial cursor on your first request, include an empty \"before\" query string.", - "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 events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "validity", - "in": "query", - "description": "A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`.", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "is_publicly_leaked", - "in": "query", - "description": "A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present.", - "required": false, - "schema": { - "type": "boolean", - "default": false - } - }, - { - "name": "is_multi_repo", + "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": "A boolean value representing whether or not to filter alerts by the multi-repo tag being present.", - "required": false, "schema": { - "type": "boolean", - "default": false + "type": "integer", + "default": 1 } }, { - "name": "hide_secret", + "name": "targets", + "description": "A comma-separated list of rule targets to filter by.\nIf provided, only rulesets that apply to the specified targets will be returned.\nFor example, `branch,tag,push`.\n", "in": "query", - "description": "A boolean value representing whether or not to hide literal secrets in the results.", "required": false, "schema": { - "type": "boolean", - "default": false + "type": "string", + "examples": [ + "branch,tag,push" + ] } } ], @@ -157706,1851 +151862,1295 @@ "schema": { "type": "array", "items": { + "title": "Repository ruleset", "type": "object", + "description": "A set of rules to apply when specified conditions are met.", + "required": [ + "id", + "name", + "source", + "enforcement" + ], "properties": { - "number": { + "id": { "type": "integer", - "description": "The security alert number.", - "readOnly": true + "description": "The ID of the ruleset" }, - "created_at": { + "name": { "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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 - } - ] + "description": "The name of the ruleset" }, - "url": { + "target": { "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true + "description": "The target of the ruleset", + "enum": [ + "branch", + "tag", + "push", + "repository" + ] }, - "html_url": { + "source_type": { "type": "string", - "description": "The GitHub URL of the alert resource.", - "format": "uri", - "readOnly": true + "description": "The type of the source of the ruleset", + "enum": [ + "Repository", + "Organization", + "Enterprise" + ] }, - "locations_url": { + "source": { "type": "string", - "format": "uri", - "description": "The REST API URL of the code locations for this alert." + "description": "The name of the source" }, - "state": { - "description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.", + "enforcement": { "type": "string", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).", "enum": [ - "open", - "resolved" + "disabled", + "active", + "evaluate" ] }, - "resolution": { - "type": [ - "string", - "null" - ], - "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "title": "Repository Ruleset Bypass Actor", + "type": "object", + "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_type" + ], + "properties": { + "actor_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + }, + "actor_type": { + "type": "string", + "enum": [ + "Integration", + "OrganizationAdmin", + "RepositoryRole", + "Team", + "DeployKey" + ], + "description": "The type of actor that can bypass a ruleset." + }, + "bypass_mode": { + "type": "string", + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", + "enum": [ + "always", + "pull_request" + ], + "default": "always" + } + } + } + }, + "current_user_can_bypass": { + "type": "string", + "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", "enum": [ - "false_positive", - "wont_fix", - "revoked", - "used_in_tests", - null + "always", + "pull_requests_only", + "never" ] }, - "resolved_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + "node_id": { + "type": "string" }, - "resolved_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", + "_links": { + "type": "object", + "properties": { + "self": { "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { + "href": { "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { + "description": "The URL of the ruleset" + } + } + }, + "html": { + "type": [ + "object", + "null" + ], + "properties": { + "href": { "type": "string", - "examples": [ - "public" - ] + "description": "The html URL of the ruleset" } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + } } - ] - }, - "secret_type": { - "type": "string", - "description": "The type of secret that secret scanning detected." - }, - "secret_type_display_name": { - "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" - }, - "secret": { - "type": "string", - "description": "The secret that was detected." + } }, - "repository": { - "title": "Simple Repository", - "description": "A GitHub repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "A unique identifier of the repository.", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "description": "The GraphQL identifier of the repository.", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "description": "The name of the repository.", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "description": "The full, globally unique, name of the repository.", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", + "conditions": { + "anyOf": [ + { + "title": "Repository ruleset conditions for ref names", "type": "object", + "description": "Parameters for a repository ruleset ref name condition", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean", - "description": "Whether the repository is private." - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL to view the repository on GitHub.com.", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The repository description.", - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL to get more information about the repository from the GitHub API.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "description": "A template for the API URL to download the repository as an archive.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "description": "A template for the API URL to list the available assignees for issues in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "description": "A template for the API URL to get information about branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "description": "A template for the API URL to get information about collaborators of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "description": "A template for the API URL to get information about comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "description": "A template for the API URL to get information about commits on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "description": "A template for the API URL to compare two commits or refs.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "description": "A template for the API URL to get the contents of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "description": "A template for the API URL to list the contributors to the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the deployments of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the downloads on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the events of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the forks of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "description": "A template for the API URL to get information about Git commits of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "description": "A template for the API URL to get information about Git refs of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "description": "A template for the API URL to get information about Git tags of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "issue_comment_url": { - "type": "string", - "description": "A template for the API URL to get information about issue comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "description": "A template for the API URL to get information about issue events on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "description": "A template for the API URL to get information about issues on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "description": "A template for the API URL to get information about deploy keys on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "description": "A template for the API URL to get information about labels of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about the languages of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "description": "The API URL to merge branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "description": "A template for the API URL to get information about milestones of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "description": "A template for the API URL to get information about notifications on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "description": "A template for the API URL to get information about pull requests on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "description": "A template for the API URL to get information about releases on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the stargazers on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "description": "A template for the API URL to get information about statuses of a commit.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the subscribers on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "description": "The API URL to subscribe to notifications for this repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about tags on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the teams on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the hooks on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks" - ] - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" - ] - }, - "push_protection_bypassed": { - "type": [ - "boolean", - "null" - ], - "description": "Whether push protection was bypassed for the detected secret." - }, - "push_protection_bypassed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "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" - ] - } - ] - }, - "push_protection_bypassed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." - }, - "push_protection_bypass_request_reviewer": { - "anyOf": [ - { - "type": "null" + } }, { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Organization ruleset conditions", "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "push_protection_bypass_request_reviewer_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment when reviewing a push protection bypass." - }, - "push_protection_bypass_request_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment when requesting a push protection bypass." - }, - "push_protection_bypass_request_html_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "description": "The URL to a push protection bypass request." - }, - "resolution_comment": { - "type": [ - "string", - "null" - ], - "description": "The comment that was optionally added when this alert was closed" - }, - "validity": { - "type": "string", - "description": "The token status as of the latest validity check.", - "enum": [ - "active", - "inactive", - "unknown" - ] - }, - "publicly_leaked": { - "type": [ - "boolean", - "null" - ], - "description": "Whether the secret was publicly leaked." - }, - "multi_repo": { - "type": [ - "boolean", - "null" - ], - "description": "Whether the detected secret was found in multiple repositories in the same organization or enterprise." - }, - "is_base64_encoded": { - "type": [ - "boolean", - "null" - ], - "description": "A boolean value representing whether or not alert is base64 encoded" - }, - "first_location_detected": { - "anyOf": [ - { - "type": "null" - }, - { - "description": "Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request.\n", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { - "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path in the repository", - "examples": [ - "/example/secrets.txt" - ] - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "examples": [ - "af5626b4a114abcb82d63db7c8082c3c4756e51b" - ] - }, - "blob_url": { - "type": "string", - "description": "The API URL to get the associated blob resource" + "title": "repository_name_and_ref_name", + "description": "Conditions to target repositories by name and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "examples": [ - "af5626b4a114abcb82d63db7c8082c3c4756e51b" + { + "title": "Repository ruleset conditions for repository names", + "type": "object", + "description": "Parameters for a repository name condition", + "properties": { + "repository_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + }, + "protected": { + "type": "boolean", + "description": "Whether renaming of target repositories is prevented." + } + } + } + }, + "required": [ + "repository_name" ] - }, - "commit_url": { - "type": "string", - "description": "The API URL to get the associated commit resource" } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "blob_url", - "commit_sha", - "commit_url" ] }, { - "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.", "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path of the wiki page", - "examples": [ - "/example/Home.md" - ] - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "examples": [ - "af5626b4a114abcb82d63db7c8082c3c4756e51b" - ] - }, - "page_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki page", - "examples": [ - "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - ] - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "examples": [ - "302c0b7e200761c9dd9b57e57db540ee0b4293a5" - ] + "title": "repository_id_and_ref_name", + "description": "Conditions to target repositories by id and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } }, - "commit_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki commit", - "examples": [ - "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + { + "title": "Repository ruleset conditions for repository IDs", + "type": "object", + "description": "Parameters for a repository ID condition", + "properties": { + "repository_id": { + "type": "object", + "properties": { + "repository_ids": { + "type": "array", + "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" + } + } + } + } + }, + "required": [ + "repository_id" ] } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "page_url", - "commit_sha", - "commit_url" ] }, { - "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", "type": "object", - "properties": { - "issue_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/1347" + "title": "repository_property_and_ref_name", + "description": "Conditions to target repositories by property and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Repository ruleset conditions for repository properties", + "type": "object", + "description": "Parameters for a repository property condition", + "properties": { + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + } + } + } + }, + "required": [ + "repository_property" ] } - }, - "required": [ - "issue_title_url" ] - }, - { - "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", - "type": "object", - "properties": { - "issue_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/1347" - ] - } + } + ] + } + ], + "type": [ + "null", + "object" + ] + }, + "rules": { + "type": "array", + "items": { + "title": "Repository Rule", + "type": "object", + "description": "A repository rule.", + "oneOf": [ + { + "title": "creation", + "description": "Only allow users with bypass permission to create matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "creation" + ] + } + } + }, + { + "title": "update", + "description": "Only allow users with bypass permission to update matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "update" + ] }, - "required": [ - "issue_body_url" - ] - }, - { - "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", - "type": "object", - "properties": { - "issue_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue comment where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - ] - } + "parameters": { + "type": "object", + "properties": { + "update_allows_fetch_and_merge": { + "type": "boolean", + "description": "Branch can pull changes from its upstream repository" + } + }, + "required": [ + "update_allows_fetch_and_merge" + ] + } + } + }, + { + "title": "deletion", + "description": "Only allow users with bypass permissions to delete matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "deletion" + ] + } + } + }, + { + "title": "required_linear_history", + "description": "Prevent merge commits from being pushed to matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_linear_history" + ] + } + } + }, + { + "title": "merge_queue", + "description": "Merges must be performed via a merge queue.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "merge_queue" + ] }, - "required": [ - "issue_comment_url" - ] - }, - { - "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", - "type": "object", - "properties": { - "discussion_title_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "examples": [ - "https://github.com/community/community/discussions/39082" - ] - } + "parameters": { + "type": "object", + "properties": { + "check_response_timeout_minutes": { + "type": "integer", + "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", + "minimum": 1, + "maximum": 360 + }, + "grouping_strategy": { + "type": "string", + "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", + "enum": [ + "ALLGREEN", + "HEADGREEN" + ] + }, + "max_entries_to_build": { + "type": "integer", + "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", + "minimum": 0, + "maximum": 100 + }, + "max_entries_to_merge": { + "type": "integer", + "description": "The maximum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "merge_method": { + "type": "string", + "description": "Method to use when merging changes from queued pull requests.", + "enum": [ + "MERGE", + "SQUASH", + "REBASE" + ] + }, + "min_entries_to_merge": { + "type": "integer", + "description": "The minimum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "min_entries_to_merge_wait_minutes": { + "type": "integer", + "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", + "minimum": 0, + "maximum": 360 + } + }, + "required": [ + "check_response_timeout_minutes", + "grouping_strategy", + "max_entries_to_build", + "max_entries_to_merge", + "merge_method", + "min_entries_to_merge", + "min_entries_to_merge_wait_minutes" + ] + } + } + }, + { + "title": "required_deployments", + "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_deployments" + ] }, - "required": [ - "discussion_title_url" - ] - }, - { - "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", - "type": "object", - "properties": { - "discussion_body_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "examples": [ - "https://github.com/community/community/discussions/39082#discussion-4566270" - ] - } + "parameters": { + "type": "object", + "properties": { + "required_deployment_environments": { + "type": "array", + "description": "The environments that must be successfully deployed to before branches can be merged.", + "items": { + "type": "string" + } + } + }, + "required": [ + "required_deployment_environments" + ] + } + } + }, + { + "title": "required_signatures", + "description": "Commits pushed to matching refs must have verified signatures.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_signatures" + ] + } + } + }, + { + "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.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "pull_request" + ] }, - "required": [ - "discussion_body_url" - ] - }, - { - "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", - "type": "object", - "properties": { - "discussion_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the discussion comment where the secret was detected.", - "examples": [ - "https://github.com/community/community/discussions/39082#discussioncomment-4158232" - ] - } + "parameters": { + "type": "object", + "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", + "items": { + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "automatic_copilot_code_review_enabled": { + "type": "boolean", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean", + "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." + }, + "require_code_owner_review": { + "type": "boolean", + "description": "Require an approving review in pull requests that modify files that have a designated code owner." + }, + "require_last_push_approval": { + "type": "boolean", + "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." + }, + "required_approving_review_count": { + "type": "integer", + "description": "The number of approving reviews that are required before a pull request can be merged.", + "minimum": 0, + "maximum": 10 + }, + "required_review_thread_resolution": { + "type": "boolean", + "description": "All conversations on code must be resolved before a pull request can be merged." + } + }, + "required": [ + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "require_last_push_approval", + "required_approving_review_count", + "required_review_thread_resolution" + ] + } + } + }, + { + "title": "required_status_checks", + "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_status_checks" + ] }, - "required": [ - "discussion_comment_url" - ] - }, - { - "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.", - "type": "object", - "properties": { - "pull_request_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - ] - } + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "required_status_checks": { + "type": "array", + "description": "Status checks that are required.", + "items": { + "title": "StatusCheckConfiguration", + "description": "Required status check", + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "The status check context name that must be present on the commit." + }, + "integration_id": { + "type": "integer", + "description": "The optional integration ID that this status check must originate from." + } + }, + "required": [ + "context" + ] + } + }, + "strict_required_status_checks_policy": { + "type": "boolean", + "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." + } + }, + "required": [ + "required_status_checks", + "strict_required_status_checks_policy" + ] + } + } + }, + { + "title": "non_fast_forward", + "description": "Prevent users with push access from force pushing to refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "non_fast_forward" + ] + } + } + }, + { + "title": "commit_message_pattern", + "description": "Parameters to be used for the commit_message_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_message_pattern" + ] }, - "required": [ - "pull_request_title_url" - ] - }, - { - "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.", - "type": "object", - "properties": { - "pull_request_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - ] - } + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "commit_author_email_pattern", + "description": "Parameters to be used for the commit_author_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_author_email_pattern" + ] }, - "required": [ - "pull_request_body_url" - ] - }, - { - "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.", - "type": "object", - "properties": { - "pull_request_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request comment where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - ] - } + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "committer_email_pattern", + "description": "Parameters to be used for the committer_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "committer_email_pattern" + ] }, - "required": [ - "pull_request_comment_url" - ] - }, - { - "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.", - "type": "object", - "properties": { - "pull_request_review_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" - ] - } + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "branch_name_pattern", + "description": "Parameters to be used for the branch_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "branch_name_pattern" + ] }, - "required": [ - "pull_request_review_url" - ] - }, - { - "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.", - "type": "object", - "properties": { - "pull_request_review_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review comment where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" - ] - } + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "tag_name_pattern", + "description": "Parameters to be used for the tag_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tag_name_pattern" + ] }, - "required": [ - "pull_request_review_comment_url" - ] + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } } - ] - } - ] - }, - "has_more_locations": { - "type": "boolean", - "description": "A boolean value representing whether or not the token in the alert was detected in more than one location." - } - } - } - }, - "examples": { - "default": { - "value": [ - { - "number": 2, - "created_at": "2020-11-06T18:48:51Z", - "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2", - "html_url": "https://github.com/owner/private-repo/security/secret-scanning/2", - "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations", - "state": "resolved", - "resolution": "false_positive", - "resolved_at": "2020-11-07T02:47:13Z", - "resolved_by": { - "login": "monalisa", - "id": 2, - "node_id": "MDQ6VXNlcjI=", - "avatar_url": "https://alambic.github.com/avatars/u/2?", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "site_admin": true - }, - "secret_type": "adafruit_io_key", - "secret_type_display_name": "Adafruit IO Key", - "secret": "aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX", - "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 + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } + }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + } + ] + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + } + }, + "examples": { + "default": { + "value": [ + { + "id": 21, + "name": "super cool ruleset", + "source_type": "Organization", + "source": "my-org", + "enforcement": "enabled", + "node_id": "RRS_lACkVXNlcgQB", + "_links": { + "self": { + "href": "https://api.github.com/orgs/my-org/rulesets/21" }, - "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" - }, - "push_protection_bypassed_by": { - "login": "monalisa", - "id": 2, - "node_id": "MDQ6VXNlcjI=", - "avatar_url": "https://alambic.github.com/avatars/u/2?", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "site_admin": true - }, - "push_protection_bypassed": true, - "push_protection_bypassed_at": "2020-11-06T21:48:51Z", - "push_protection_bypass_request_reviewer": { - "login": "octocat", - "id": 3, - "node_id": "MDQ6VXNlcjI=", - "avatar_url": "https://alambic.github.com/avatars/u/3?", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": true - }, - "push_protection_bypass_request_reviewer_comment": "Example response", - "push_protection_bypass_request_comment": "Example comment", - "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", - "resolution_comment": "Example comment", - "validity": "active", - "publicly_leaked": false, - "multi_repo": false, - "is_base64_encoded": false, - "first_location_detected": { - "path": "/example/secrets.txt", - "start_line": 1, - "end_line": 1, - "start_column": 1, - "end_column": 64, - "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", - "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", - "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", - "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + "html": { + "href": "https://github.com/organizations/my-org/settings/rules/21" + } }, - "has_more_locations": true + "created_at": "2023-07-15T08:43:03Z", + "updated_at": "2023-08-23T16:29:47Z" }, { - "number": 1, - "created_at": "2020-11-06T18:18:30Z", - "url": "https://api.github.com/repos/owner/repo/secret-scanning/alerts/1", - "html_url": "https://github.com/owner/repo/security/secret-scanning/1", - "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/1/locations", - "state": "open", - "resolution": null, - "resolved_at": null, - "resolved_by": null, - "secret_type": "mailchimp_api_key", - "secret_type_display_name": "Mailchimp API Key", - "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", - "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 + "id": 432, + "name": "Another ruleset", + "source_type": "Organization", + "source": "my-org", + "enforcement": "enabled", + "node_id": "RRS_lACkVXNlcgQQ", + "_links": { + "self": { + "href": "https://api.github.com/orgs/my-org/rulesets/432" }, - "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" - }, - "push_protection_bypassed_by": null, - "push_protection_bypassed": false, - "push_protection_bypassed_at": null, - "push_protection_bypass_request_reviewer": null, - "push_protection_bypass_request_reviewer_comment": null, - "push_protection_bypass_request_comment": null, - "push_protection_bypass_request_html_url": null, - "resolution_comment": null, - "validity": "unknown", - "publicly_leaked": false, - "multi_repo": false, - "is_base64_encoded": false, - "first_location_detected": { - "issue_title_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + "html": { + "href": "https://github.com/organizations/my-org/settings/rules/432" + } }, - "has_more_locations": false + "created_at": "2023-08-15T08:43:03Z", + "updated_at": "2023-09-23T16:29:47Z" } ] } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } } }, "404": { @@ -159579,47 +153179,50 @@ } } }, - "503": { - "description": "Service unavailable", + "500": { + "description": "Internal Error", "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" } } } } } } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "secret-scanning", - "subcategory": "secret-scanning" } - } - }, - "/orgs/{org}/security-advisories": { - "get": { - "summary": "List repository security advisories for an organization", - "description": "Lists repository security advisories 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 `repo` or `repository_advisories:write` scope to use this endpoint.", + }, + "post": { + "summary": "Create an organization repository ruleset", + "description": "Create a repository ruleset for an organization.", "tags": [ - "security-advisories" + "repos" ], - "operationId": "security-advisories/list-org-repository-advisories", + "operationId": "repos/create-org-ruleset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization" + "url": "https://docs.github.com/rest/orgs/rules#create-an-organization-repository-ruleset" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "rules" }, "parameters": [ { @@ -159630,2484 +153233,2448 @@ "schema": { "type": "string" } - }, - { - "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": "string", - "enum": [ - "created", - "updated", - "published" - ], - "default": "created" - } - }, - { - "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": "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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 - } - }, - { - "name": "state", - "description": "Filter by the state of the repository advisories. Only advisories of this state will be returned.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "triage", - "draft", - "published", - "closed" - ] - } } ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "description": "A repository security advisory.", + "requestBody": { + "description": "Request body", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the ruleset." + }, + "target": { + "type": "string", + "description": "The target of the ruleset", + "enum": [ + "branch", + "tag", + "push", + "repository" + ], + "default": "branch" + }, + "enforcement": { + "type": "string", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).", + "enum": [ + "disabled", + "active", + "evaluate" + ] + }, + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "title": "Repository Ruleset Bypass Actor", + "type": "object", + "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_type" + ], + "properties": { + "actor_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + }, + "actor_type": { + "type": "string", + "enum": [ + "Integration", + "OrganizationAdmin", + "RepositoryRole", + "Team", + "DeployKey" + ], + "description": "The type of actor that can bypass a ruleset." + }, + "bypass_mode": { + "type": "string", + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", + "enum": [ + "always", + "pull_request" + ], + "default": "always" + } + } + } + }, + "conditions": { + "title": "Organization ruleset conditions", "type": "object", - "properties": { - "ghsa_id": { - "type": "string", - "description": "The GitHub Security Advisory ID.", - "readOnly": true - }, - "cve_id": { - "type": [ - "string", - "null" - ], - "description": "The Common Vulnerabilities and Exposures (CVE) ID." - }, - "url": { - "type": "string", - "format": "uri", - "description": "The API URL for the advisory.", - "readOnly": true - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL for the advisory.", - "readOnly": true - }, - "summary": { - "type": "string", - "description": "A short summary of the advisory.", - "maxLength": 1024 - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "A detailed description of what the advisory entails.", - "maxLength": 65535 - }, - "severity": { - "type": [ - "string", - "null" - ], - "description": "The severity of the advisory.", - "enum": [ - "critical", - "high", - "medium", - "low", - null + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", + "oneOf": [ + { + "type": "object", + "title": "repository_name_and_ref_name", + "description": "Conditions to target repositories by name and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Repository ruleset conditions for repository names", + "type": "object", + "description": "Parameters for a repository name condition", + "properties": { + "repository_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + }, + "protected": { + "type": "boolean", + "description": "Whether renaming of target repositories is prevented." + } + } + } + }, + "required": [ + "repository_name" + ] + } ] }, - "author": { - "readOnly": true, - "description": "The author of the advisory.", + { + "type": "object", + "title": "repository_id_and_ref_name", + "description": "Conditions to target repositories by id and refs by name", "allOf": [ { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Repository ruleset conditions for ref names", "type": "object", + "description": "Parameters for a repository ruleset ref name condition", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Repository ruleset conditions for repository IDs", + "type": "object", + "description": "Parameters for a repository ID condition", + "properties": { + "repository_id": { + "type": "object", + "properties": { + "repository_ids": { + "type": "array", + "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "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" + "repository_id" ] } - ], - "type": [ - "null" ] }, - "publisher": { - "readOnly": true, - "description": "The publisher of the advisory.", + { + "type": "object", + "title": "repository_property_and_ref_name", + "description": "Conditions to target repositories by property and refs by name", "allOf": [ { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Repository ruleset conditions for ref names", "type": "object", + "description": "Parameters for a repository ruleset ref name condition", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Repository ruleset conditions for repository properties", + "type": "object", + "description": "Parameters for a repository property condition", + "properties": { + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + } + } } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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_property" ] } - ], - "type": [ - "null" ] - }, - "identifiers": { - "type": "array", - "items": { + } + ] + }, + "rules": { + "type": "array", + "description": "An array of rules within the ruleset.", + "items": { + "title": "Repository Rule", + "type": "object", + "description": "A repository rule.", + "oneOf": [ + { + "title": "creation", + "description": "Only allow users with bypass permission to create matching refs.", "type": "object", + "required": [ + "type" + ], "properties": { "type": { "type": "string", - "description": "The type of identifier.", "enum": [ - "CVE", - "GHSA" + "creation" ] - }, - "value": { + } + } + }, + { + "title": "update", + "description": "Only allow users with bypass permission to update matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "description": "The identifier value." + "enum": [ + "update" + ] + }, + "parameters": { + "type": "object", + "properties": { + "update_allows_fetch_and_merge": { + "type": "boolean", + "description": "Branch can pull changes from its upstream repository" + } + }, + "required": [ + "update_allows_fetch_and_merge" + ] } - }, + } + }, + { + "title": "deletion", + "description": "Only allow users with bypass permissions to delete matching refs.", + "type": "object", "required": [ - "type", - "value" - ] + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "deletion" + ] + } + } }, - "readOnly": true - }, - "state": { - "type": "string", - "description": "The state of the advisory.", - "enum": [ - "published", - "closed", - "withdrawn", - "draft", - "triage" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The date and time of when the advisory was created, in ISO 8601 format.", - "readOnly": true - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The date and time of when the advisory was last updated, in ISO 8601 format.", - "readOnly": true - }, - "published_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The date and time of when the advisory was published, in ISO 8601 format.", - "readOnly": true - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The date and time of when the advisory was closed, in ISO 8601 format.", - "readOnly": true - }, - "withdrawn_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.", - "readOnly": true - }, - "submission": { - "type": [ - "object", - "null" - ], - "readOnly": true, - "properties": { - "accepted": { - "type": "boolean", - "description": "Whether a private vulnerability report was accepted by the repository's administrators.", - "readOnly": true + { + "title": "required_linear_history", + "description": "Prevent merge commits from being pushed to matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_linear_history" + ] + } } }, - "required": [ - "accepted" - ] - }, - "vulnerabilities": { - "type": [ - "array", - "null" - ], - "items": { - "description": "A product affected by the vulnerability detailed in a repository security advisory.", + { + "title": "required_deployments", + "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", "type": "object", + "required": [ + "type" + ], "properties": { - "package": { - "description": "The name of the package affected by the vulnerability.", - "type": [ - "object", - "null" - ], + "type": { + "type": "string", + "enum": [ + "required_deployments" + ] + }, + "parameters": { + "type": "object", "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "enum": [ - "rubygems", - "npm", - "pip", - "maven", - "nuget", - "composer", - "go", - "rust", - "erlang", - "actions", - "pub", - "other", - "swift" - ] - }, - "name": { - "type": [ - "string", - "null" - ], - "description": "The unique package name within its ecosystem." + "required_deployment_environments": { + "type": "array", + "description": "The environments that must be successfully deployed to before branches can be merged.", + "items": { + "type": "string" + } } }, "required": [ - "ecosystem", - "name" + "required_deployment_environments" ] - }, - "vulnerable_version_range": { - "type": [ - "string", - "null" - ], - "description": "The range of the package versions affected by the vulnerability." - }, - "patched_versions": { - "type": [ - "string", - "null" - ], - "description": "The package version(s) that resolve the vulnerability." - }, - "vulnerable_functions": { - "type": [ - "array", - "null" - ], - "description": "The functions in the package that are affected.", - "items": { - "type": "string" - } } - }, + } + }, + { + "title": "required_signatures", + "description": "Commits pushed to matching refs must have verified signatures.", + "type": "object", "required": [ - "package", - "vulnerable_version_range", - "patched_versions", - "vulnerable_functions" + "type" ], - "additionalProperties": false - } - }, - "cvss": { - "type": [ - "object", - "null" - ], - "properties": { - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The CVSS vector." - }, - "score": { - "type": [ - "number", - "null" - ], - "description": "The CVSS score.", - "minimum": 0, - "maximum": 10, - "readOnly": true + "properties": { + "type": { + "type": "string", + "enum": [ + "required_signatures" + ] + } } }, - "required": [ - "vector_string", - "score" - ] - }, - "cvss_severities": { - "type": [ - "object", - "null" - ], - "properties": { - "cvss_v3": { - "type": [ - "object", - "null" - ], - "properties": { - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The CVSS 3 vector string." - }, - "score": { - "type": [ - "number", - "null" - ], - "description": "The CVSS 3 score.", - "minimum": 0, - "maximum": 10, - "readOnly": true - } + { + "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.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "pull_request" + ] }, - "required": [ - "vector_string", - "score" - ] - }, - "cvss_v4": { - "type": [ - "object", - "null" - ], - "properties": { - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The CVSS 4 vector string." + "parameters": { + "type": "object", + "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", + "items": { + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "automatic_copilot_code_review_enabled": { + "type": "boolean", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean", + "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." + }, + "require_code_owner_review": { + "type": "boolean", + "description": "Require an approving review in pull requests that modify files that have a designated code owner." + }, + "require_last_push_approval": { + "type": "boolean", + "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." + }, + "required_approving_review_count": { + "type": "integer", + "description": "The number of approving reviews that are required before a pull request can be merged.", + "minimum": 0, + "maximum": 10 + }, + "required_review_thread_resolution": { + "type": "boolean", + "description": "All conversations on code must be resolved before a pull request can be merged." + } }, - "score": { - "type": [ - "number", - "null" - ], - "description": "The CVSS 4 score.", - "minimum": 0, - "maximum": 10, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] + "required": [ + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "require_last_push_approval", + "required_approving_review_count", + "required_review_thread_resolution" + ] + } } - } - }, - "cwes": { - "type": [ - "array", - "null" - ], - "items": { + }, + { + "title": "required_status_checks", + "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", "type": "object", + "required": [ + "type" + ], "properties": { - "cwe_id": { + "type": { "type": "string", - "description": "The Common Weakness Enumeration (CWE) identifier." + "enum": [ + "required_status_checks" + ] }, - "name": { - "type": "string", - "description": "The name of the CWE.", - "readOnly": true + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "required_status_checks": { + "type": "array", + "description": "Status checks that are required.", + "items": { + "title": "StatusCheckConfiguration", + "description": "Required status check", + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "The status check context name that must be present on the commit." + }, + "integration_id": { + "type": "integer", + "description": "The optional integration ID that this status check must originate from." + } + }, + "required": [ + "context" + ] + } + }, + "strict_required_status_checks_policy": { + "type": "boolean", + "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." + } + }, + "required": [ + "required_status_checks", + "strict_required_status_checks_policy" + ] } - }, - "required": [ - "cwe_id", - "name" - ] + } }, - "readOnly": true - }, - "cwe_ids": { - "type": [ - "array", - "null" - ], - "description": "A list of only the CWE IDs.", - "items": { - "type": "string" - } - }, - "credits": { - "type": [ - "array", - "null" - ], - "items": { + { + "title": "non_fast_forward", + "description": "Prevent users with push access from force pushing to refs.", "type": "object", + "required": [ + "type" + ], "properties": { - "login": { - "type": "string", - "description": "The username of the user credited." - }, "type": { "type": "string", - "description": "The type of credit the user is receiving.", "enum": [ - "analyst", - "finder", - "reporter", - "coordinator", - "remediation_developer", - "remediation_reviewer", - "remediation_verifier", - "tool", - "sponsor", - "other" + "non_fast_forward" ] } } - } - }, - "credits_detailed": { - "type": [ - "array", - "null" - ], - "items": { - "description": "A credit given to a user for a repository security advisory.", + }, + { + "title": "commit_message_pattern", + "description": "Parameters to be used for the commit_message_pattern rule", "type": "object", + "required": [ + "type" + ], "properties": { - "user": { - "title": "Simple User", - "description": "A GitHub user.", + "type": { + "type": "string", + "enum": [ + "commit_message_pattern" + ] + }, + "parameters": { "type": "object", "properties": { "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] + "description": "How this rule will appear to users." }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." }, - "avatar_url": { + "operator": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" ] }, - "url": { + "pattern": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "commit_author_email_pattern", + "description": "Parameters to be used for the commit_author_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_author_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] + "description": "How this rule will appear to users." }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." }, - "following_url": { + "operator": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" ] }, - "gists_url": { + "pattern": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "committer_email_pattern", + "description": "Parameters to be used for the committer_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "committer_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] + "description": "How this rule will appear to users." }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." }, - "organizations_url": { + "operator": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" ] }, - "repos_url": { + "pattern": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "branch_name_pattern", + "description": "Parameters to be used for the branch_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "branch_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "description": "How this rule will appear to users." }, - "received_events_url": { + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" ] }, - "type": { + "pattern": { "type": "string", - "examples": [ - "User" - ] + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "tag_name_pattern", + "description": "Parameters to be used for the tag_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tag_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." }, - "site_admin": { - "type": "boolean" + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." }, - "starred_at": { + "operator": { "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" ] }, - "user_view_type": { + "pattern": { "type": "string", - "examples": [ - "public" - ] + "description": "The pattern to match with." } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "operator", + "pattern" ] - }, + } + } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { "type": { "type": "string", - "description": "The type of credit the user is receiving.", "enum": [ - "analyst", - "finder", - "reporter", - "coordinator", - "remediation_developer", - "remediation_reviewer", - "remediation_verifier", - "tool", - "sponsor", - "other" + "file_path_restriction" ] }, - "state": { - "type": "string", - "description": "The state of the user's acceptance of the credit.", - "enum": [ - "accepted", - "declined", - "pending" + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" ] } - }, - "required": [ - "user", - "type", - "state" - ], - "additionalProperties": false + } }, - "readOnly": true - }, - "collaborating_users": { - "type": [ - "array", - "null" - ], - "description": "A list of users that collaborate on the advisory.", - "items": { - "title": "Simple User", - "description": "A GitHub user.", + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", "type": "object", + "required": [ + "type" + ], "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { + "type": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "enum": [ + "max_file_path_length" ] }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" ] - }, - "starred_url": { + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "enum": [ + "file_extension_restriction" ] }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" ] - }, - "organizations_url": { + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" + "enum": [ + "max_file_size" ] }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" ] - }, - "events_url": { + } + } + }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "enum": [ + "workflows" ] }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" ] - }, + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { "type": { "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" + "enum": [ + "code_scanning" ] }, - "user_view_type": { - "type": "string", - "examples": [ - "public" + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" ] } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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": [ + "name", + "enforcement" + ] + }, + "examples": { + "default": { + "value": { + "name": "super cool ruleset", + "target": "branch", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] }, - "collaborating_teams": { - "type": [ - "array", - "null" + "repository_name": { + "include": [ + "important_repository", + "another_important_repository" ], - "description": "A list of teams that collaborate on the advisory.", - "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", + "exclude": [ + "unimportant_repository" + ], + "protected": true + } + }, + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" + } + } + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Repository ruleset", + "type": "object", + "description": "A set of rules to apply when specified conditions are met.", + "required": [ + "id", + "name", + "source", + "enforcement" + ], + "properties": { + "id": { + "type": "integer", + "description": "The ID of the ruleset" + }, + "name": { + "type": "string", + "description": "The name of the ruleset" + }, + "target": { + "type": "string", + "description": "The target of the ruleset", + "enum": [ + "branch", + "tag", + "push", + "repository" + ] + }, + "source_type": { + "type": "string", + "description": "The type of the source of the ruleset", + "enum": [ + "Repository", + "Organization", + "Enterprise" + ] + }, + "source": { + "type": "string", + "description": "The name of the source" + }, + "enforcement": { + "type": "string", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).", + "enum": [ + "disabled", + "active", + "evaluate" + ] + }, + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "title": "Repository Ruleset Bypass Actor", + "type": "object", + "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_type" + ], + "properties": { + "actor_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + }, + "actor_type": { + "type": "string", + "enum": [ + "Integration", + "OrganizationAdmin", + "RepositoryRole", + "Team", + "DeployKey" + ], + "description": "The type of actor that can bypass a ruleset." + }, + "bypass_mode": { + "type": "string", + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", + "enum": [ + "always", + "pull_request" + ], + "default": "always" + } + } + } + }, + "current_user_can_bypass": { + "type": "string", + "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", + "enum": [ + "always", + "pull_requests_only", + "never" + ] + }, + "node_id": { + "type": "string" + }, + "_links": { + "type": "object", + "properties": { + "self": { "type": "object", "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { + "href": { + "type": "string", + "description": "The URL of the ruleset" + } + } + }, + "html": { + "type": [ + "object", + "null" + ], + "properties": { + "href": { + "type": "string", + "description": "The html URL of the ruleset" + } + } + } + } + }, + "conditions": { + "anyOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { "type": "object", "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } }, - "maintain": { - "type": "boolean" + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Organization ruleset conditions", + "type": "object", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", + "oneOf": [ + { + "type": "object", + "title": "repository_name_and_ref_name", + "description": "Conditions to target repositories by name and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } }, - "admin": { - "type": "boolean" + { + "title": "Repository ruleset conditions for repository names", + "type": "object", + "description": "Parameters for a repository name condition", + "properties": { + "repository_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + }, + "protected": { + "type": "boolean", + "description": "Whether renaming of target repositories is prevented." + } + } + } + }, + "required": [ + "repository_name" + ] } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" ] }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" + { + "type": "object", + "title": "repository_id_and_ref_name", + "description": "Conditions to target repositories by id and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Repository ruleset conditions for repository IDs", + "type": "object", + "description": "Parameters for a repository ID condition", + "properties": { + "repository_id": { + "type": "object", + "properties": { + "repository_ids": { + "type": "array", + "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" + } + } + } + } + }, + "required": [ + "repository_id" + ] + } ] }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ + { + "type": "object", + "title": "repository_property_and_ref_name", + "description": "Conditions to target repositories by property and refs by name", + "allOf": [ { - "type": "null" + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } }, { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", + "title": "Repository ruleset conditions for repository properties", "type": "object", + "description": "Parameters for a repository property condition", "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + } + } } }, "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" + "repository_property" ] } ] } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" ] } - }, - "private_fork": { - "readOnly": true, - "description": "A temporary private fork of the advisory's repository for collaborating on a fix.", - "allOf": [ + ], + "type": [ + "null", + "object" + ] + }, + "rules": { + "type": "array", + "items": { + "title": "Repository Rule", + "type": "object", + "description": "A repository rule.", + "oneOf": [ { - "title": "Simple Repository", - "description": "A GitHub repository.", + "title": "creation", + "description": "Only allow users with bypass permission to create matching refs.", "type": "object", + "required": [ + "type" + ], "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "A unique identifier of the repository.", - "examples": [ - 1296269 + "type": { + "type": "string", + "enum": [ + "creation" ] - }, - "node_id": { + } + } + }, + { + "title": "update", + "description": "Only allow users with bypass permission to update matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "description": "The GraphQL identifier of the repository.", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "enum": [ + "update" ] }, - "name": { + "parameters": { + "type": "object", + "properties": { + "update_allows_fetch_and_merge": { + "type": "boolean", + "description": "Branch can pull changes from its upstream repository" + } + }, + "required": [ + "update_allows_fetch_and_merge" + ] + } + } + }, + { + "title": "deletion", + "description": "Only allow users with bypass permissions to delete matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "description": "The name of the repository.", - "examples": [ - "Hello-World" + "enum": [ + "deletion" ] - }, - "full_name": { + } + } + }, + { + "title": "required_linear_history", + "description": "Prevent merge commits from being pushed to matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "description": "The full, globally unique, name of the repository.", - "examples": [ - "octocat/Hello-World" + "enum": [ + "required_linear_history" + ] + } + } + }, + { + "title": "merge_queue", + "description": "Merges must be performed via a merge queue.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "merge_queue" ] }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", + "parameters": { "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] + "check_response_timeout_minutes": { + "type": "integer", + "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", + "minimum": 1, + "maximum": 360 }, - "login": { + "grouping_strategy": { "type": "string", - "examples": [ - "octocat" + "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", + "enum": [ + "ALLGREEN", + "HEADGREEN" ] }, - "id": { + "max_entries_to_build": { "type": "integer", - "format": "int64", - "examples": [ - 1 - ] + "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", + "minimum": 0, + "maximum": 100 }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "max_entries_to_merge": { + "type": "integer", + "description": "The maximum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 }, - "avatar_url": { + "merge_method": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "description": "Method to use when merging changes from queued pull requests.", + "enum": [ + "MERGE", + "SQUASH", + "REBASE" ] }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] + "min_entries_to_merge": { + "type": "integer", + "description": "The minimum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] + "min_entries_to_merge_wait_minutes": { + "type": "integer", + "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", + "minimum": 0, + "maximum": 360 + } + }, + "required": [ + "check_response_timeout_minutes", + "grouping_strategy", + "max_entries_to_build", + "max_entries_to_merge", + "merge_method", + "min_entries_to_merge", + "min_entries_to_merge_wait_minutes" + ] + } + } + }, + { + "title": "required_deployments", + "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_deployments" + ] + }, + "parameters": { + "type": "object", + "properties": { + "required_deployment_environments": { + "type": "array", + "description": "The environments that must be successfully deployed to before branches can be merged.", + "items": { + "type": "string" + } + } + }, + "required": [ + "required_deployment_environments" + ] + } + } + }, + { + "title": "required_signatures", + "description": "Commits pushed to matching refs must have verified signatures.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_signatures" + ] + } + } + }, + { + "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.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "pull_request" + ] + }, + "parameters": { + "type": "object", + "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", + "items": { + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] + "automatic_copilot_code_review_enabled": { + "type": "boolean", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] + "dismiss_stale_reviews_on_push": { + "type": "boolean", + "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] + "require_code_owner_review": { + "type": "boolean", + "description": "Require an approving review in pull requests that modify files that have a designated code owner." }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] + "require_last_push_approval": { + "type": "boolean", + "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] + "required_approving_review_count": { + "type": "integer", + "description": "The number of approving reviews that are required before a pull request can be merged.", + "minimum": 0, + "maximum": 10 }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "required_review_thread_resolution": { + "type": "boolean", + "description": "All conversations on code must be resolved before a pull request can be merged." + } + }, + "required": [ + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "require_last_push_approval", + "required_approving_review_count", + "required_review_thread_resolution" + ] + } + } + }, + { + "title": "required_status_checks", + "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_status_checks" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] + "required_status_checks": { + "type": "array", + "description": "Status checks that are required.", + "items": { + "title": "StatusCheckConfiguration", + "description": "Required status check", + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "The status check context name that must be present on the commit." + }, + "integration_id": { + "type": "integer", + "description": "The optional integration ID that this status check must originate from." + } + }, + "required": [ + "context" + ] + } }, - "repos_url": { + "strict_required_status_checks_policy": { + "type": "boolean", + "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." + } + }, + "required": [ + "required_status_checks", + "strict_required_status_checks_policy" + ] + } + } + }, + { + "title": "non_fast_forward", + "description": "Prevent users with push access from force pushing to refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "non_fast_forward" + ] + } + } + }, + { + "title": "commit_message_pattern", + "description": "Parameters to be used for the commit_message_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_message_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] + "description": "How this rule will appear to users." }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." }, - "received_events_url": { + "operator": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" ] }, - "type": { + "pattern": { "type": "string", - "examples": [ - "User" - ] + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "commit_author_email_pattern", + "description": "Parameters to be used for the commit_author_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_author_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." }, - "site_admin": { - "type": "boolean" + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." }, - "starred_at": { + "operator": { "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" ] }, - "user_view_type": { + "pattern": { "type": "string", - "examples": [ - "public" - ] + "description": "The pattern to match with." } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "operator", + "pattern" ] - }, - "private": { - "type": "boolean", - "description": "Whether the repository is private." - }, - "html_url": { + } + } + }, + { + "title": "committer_email_pattern", + "description": "Parameters to be used for the committer_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "format": "uri", - "description": "The URL to view the repository on GitHub.com.", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The repository description.", - "examples": [ - "This your first repo!" + "enum": [ + "committer_email_pattern" ] }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL to get more information about the repository from the GitHub API.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" ] - }, - "archive_url": { + } + } + }, + { + "title": "branch_name_pattern", + "description": "Parameters to be used for the branch_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "description": "A template for the API URL to download the repository as an archive.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + "enum": [ + "branch_name_pattern" ] }, - "assignees_url": { - "type": "string", - "description": "A template for the API URL to list the available assignees for issues in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" ] - }, - "blobs_url": { + } + } + }, + { + "title": "tag_name_pattern", + "description": "Parameters to be used for the tag_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + "enum": [ + "tag_name_pattern" ] }, - "branches_url": { - "type": "string", - "description": "A template for the API URL to get information about branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" ] - }, - "collaborators_url": { + } + } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "description": "A template for the API URL to get information about collaborators of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + "enum": [ + "file_path_restriction" ] }, - "comments_url": { - "type": "string", - "description": "A template for the API URL to get information about comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/comments{/number}" + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" ] - }, - "commits_url": { + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "description": "A template for the API URL to get information about commits on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "enum": [ + "max_file_path_length" ] }, - "compare_url": { - "type": "string", - "description": "A template for the API URL to compare two commits or refs.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" ] - }, - "contents_url": { + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "description": "A template for the API URL to get the contents of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "enum": [ + "file_extension_restriction" ] }, - "contributors_url": { - "type": "string", - "format": "uri", - "description": "A template for the API URL to list the contributors to the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contributors" + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" ] - }, - "deployments_url": { + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "format": "uri", - "description": "The API URL to list the deployments of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/deployments" + "enum": [ + "max_file_size" ] }, - "downloads_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the downloads on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/downloads" + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" ] - }, - "events_url": { + } + } + }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "format": "uri", - "description": "The API URL to list the events of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/events" + "enum": [ + "workflows" ] }, - "forks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the forks of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "description": "A template for the API URL to get information about Git commits of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "description": "A template for the API URL to get information about Git refs of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "description": "A template for the API URL to get information about Git tags of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "issue_comment_url": { - "type": "string", - "description": "A template for the API URL to get information about issue comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "description": "A template for the API URL to get information about issue events on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "description": "A template for the API URL to get information about issues on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "description": "A template for the API URL to get information about deploy keys on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "description": "A template for the API URL to get information about labels of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about the languages of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "description": "The API URL to merge branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "description": "A template for the API URL to get information about milestones of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "description": "A template for the API URL to get information about notifications on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "description": "A template for the API URL to get information about pull requests on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "description": "A template for the API URL to get information about releases on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the stargazers on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "description": "A template for the API URL to get information about statuses of a commit.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the subscribers on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "description": "The API URL to subscribe to notifications for this repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about tags on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the teams on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/teams" + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" ] - }, - "trees_url": { + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + "enum": [ + "code_scanning" ] }, - "hooks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the hooks on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks" + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" ] } - }, - "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" - ] + } } - ], - "type": [ - "null" ] } }, - "required": [ - "ghsa_id", - "cve_id", - "url", - "html_url", - "summary", - "description", - "severity", - "author", - "publisher", - "identifiers", - "state", - "created_at", - "updated_at", - "published_at", - "closed_at", - "withdrawn_at", - "submission", - "vulnerabilities", - "cvss", - "cwes", - "cwe_ids", - "credits", - "credits_detailed", - "collaborating_users", - "collaborating_teams", - "private_fork" - ], - "additionalProperties": false + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } } }, "examples": { "default": { - "value": [ - { - "ghsa_id": "GHSA-abcd-1234-efgh", - "cve_id": "CVE-2050-00000", - "url": "https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh", - "html_url": "https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh", - "summary": "A short summary of the advisory.", - "description": "A detailed description of what the advisory entails.", - "severity": "critical", - "author": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "publisher": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "identifiers": [ - { - "type": "GHSA", - "value": "GHSA-abcd-1234-efgh" - }, - { - "type": "CVE", - "value": "CVE-2050-00000" - } - ], - "state": "published", - "created_at": "2020-01-01T00:00:00Z", - "updated_at": "2020-01-02T00:00:00Z", - "published_at": "2020-01-03T00:00:00Z", - "closed_at": null, - "withdrawn_at": null, - "submission": null, - "vulnerabilities": [ - { - "package": { - "ecosystem": "pip", - "name": "a-package" - }, - "vulnerable_version_range": ">= 1.0.0, < 1.0.1", - "patched_versions": "1.0.1", - "vulnerable_functions": [ - "function1" - ] - }, - { - "package": { - "ecosystem": "pip", - "name": "another-package" - }, - "vulnerable_version_range": ">= 1.0.0, < 1.0.2", - "patched_versions": "1.0.2", - "vulnerable_functions": [ - "function2" - ] - } - ], - "cvss": { - "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", - "score": 9.8 - }, - "cvss_severities": { - "cvss_v3": { - "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", - "score": 9.8 - }, - "cvss_v4": { - "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", - "score": 9.3 - } + "value": { + "id": 21, + "name": "super cool ruleset", + "target": "branch", + "source_type": "Organization", + "source": "my-org", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] }, - "cwes": [ - { - "cwe_id": "CWE-123", - "name": "A CWE" - } - ], - "cwe_ids": [ - "CWE-123" - ], - "credits": [ - { - "login": "octocat", - "type": "analyst" - } - ], - "credits_detailed": [ - { - "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 - }, - "type": "analyst", - "state": "accepted" - } - ], - "collaborating_users": [ - { - "login": "octokitten", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "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 - } - ], - "collaborating_teams": [ - { - "name": "Justice League", - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "permission": "admin", - "parent": null - } - ], - "private_fork": null + "repository_name": { + "include": [ + "important_repository", + "another_important_repository" + ], + "exclude": [ + "unimportant_repository" + ], + "protected": true + } }, - { - "ghsa_id": "GHSA-1234-5678-9012", - "cve_id": "CVE-2051-0000", - "url": "https://api.github.com/repos/repo/a-package/security-advisories/GHSA-1234-5678-9012", - "html_url": "https://github.com/repo/a-package/security/advisories/GHSA-1234-5678-9012", - "summary": "A short summary of the advisory.", - "description": "A detailed description of what the advisory entails.", - "severity": "low", - "author": { - "login": "monauser", - "id": 2, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/monauser", - "html_url": "https://github.com/monauser", - "followers_url": "https://api.github.com/users/monauser/followers", - "following_url": "https://api.github.com/users/monauser/following{/other_user}", - "gists_url": "https://api.github.com/users/monauser/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monauser/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monauser/subscriptions", - "organizations_url": "https://api.github.com/users/monauser/orgs", - "repos_url": "https://api.github.com/users/monauser/repos", - "events_url": "https://api.github.com/users/monauser/events{/privacy}", - "received_events_url": "https://api.github.com/users/monauser/received_events", - "type": "User", - "site_admin": false - }, - "publisher": { - "login": "monalisa", - "id": 3, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "site_admin": false - }, - "identifiers": [ - { - "type": "GHSA", - "value": "GHSA-1234-5678-9012" - }, - { - "type": "CVE", - "value": "CVE-2051-00000" - } - ], - "state": "published", - "created_at": "2020-01-03T00:00:00Z", - "updated_at": "2020-01-04T00:00:00Z", - "published_at": "2020-01-04T00:00:00Z", - "closed_at": null, - "withdrawn_at": null, - "submission": { - "accepted": true - }, - "vulnerabilities": [ - { - "package": { - "ecosystem": "pip", - "name": "a-package" - }, - "vulnerable_version_range": ">= 1.0.0, < 1.0.1", - "patched_versions": "1.0.1", - "vulnerable_functions": [ - "function1" - ] - }, - { - "package": { - "ecosystem": "pip", - "name": "another-package" - }, - "vulnerable_version_range": ">= 1.0.0, < 1.0.2", - "patched_versions": "1.0.2", - "vulnerable_functions": [ - "function2" - ] - } - ], - "cvss": { - "vector_string": "AV:P/AC:H/PR:H/UI:R/S:U/C:N/I:L/A:N", - "score": 1.6 - }, - "cvss_severities": { - "cvss_v3": { - "vector_string": "CVSS:3.1/AV:P/AC:H/PR:H/UI:R/S:U/C:N/I:L/A:N", - "score": 1.6 - }, - "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": 7.1 + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" } + } + ], + "node_id": "RRS_lACkVXNlcgQB", + "_links": { + "self": { + "href": "https://api.github.com/orgs/my-org/rulesets/21" }, - "cwes": [ - { - "cwe_id": "CWE-456", - "name": "A CWE 2.0" - } - ], - "cwe_ids": [ - "CWE-456" - ], - "credits": [ - { - "login": "monauser", - "type": "reporter" - } - ], - "credits_detailed": [ - { - "user": { - "login": "monauser", - "id": 2, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/monauser", - "html_url": "https://github.com/monauser", - "followers_url": "https://api.github.com/users/monauser/followers", - "following_url": "https://api.github.com/users/monauser/following{/other_user}", - "gists_url": "https://api.github.com/users/monauser/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monauser/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monauser/subscriptions", - "organizations_url": "https://api.github.com/users/monauser/orgs", - "repos_url": "https://api.github.com/users/monauser/repos", - "events_url": "https://api.github.com/users/monauser/events{/privacy}", - "received_events_url": "https://api.github.com/users/monauser/received_events", - "type": "User", - "site_admin": false - }, - "type": "reporter", - "state": "accepted" - } - ], - "collaborating_users": [ - { - "login": "octokitten", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "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 - } - ], - "collaborating_teams": [ - { - "name": "Justice League", - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "permission": "admin", - "parent": null - } - ], - "private_fork": { - "id": 217723378, - "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=", - "name": "octo-repo-ghsa-1234-5678-9012", - "full_name": "octo-org/octo-repo-ghsa-1234-5678-9012", - "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-ghsa-1234-5678-9012", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012", - "archive_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/comments{/number}", - "commits_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/commits{/sha}", - "compare_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/contributors", - "deployments_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/deployments", - "downloads_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/downloads", - "events_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/events", - "forks_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/forks", - "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/tags{/sha}", - "hooks_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/hooks", - "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/issues{/number}", - "keys_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/labels{/name}", - "languages_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/languages", - "merges_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/merges", - "milestones_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/pulls{/number}", - "releases_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/releases{/id}", - "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/stargazers", - "statuses_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/subscribers", - "subscription_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/subscription", - "tags_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/tags", - "teams_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/teams", - "trees_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/trees{/sha}" + "html": { + "href": "https://github.com/organizations/my-org/settings/rules/21" } - } - ] + }, + "created_at": "2023-08-15T08:43:03Z", + "updated_at": "2023-09-23T16:29:47Z" + } } } } } }, - "400": { - "description": "Bad Request", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -162129,53 +155696,11 @@ } } } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": [ - "string", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } } } }, - "404": { - "description": "Resource not found", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -162200,26 +155725,20 @@ } } } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "security-advisories", - "subcategory": "repository-advisories" } } }, - "/orgs/{org}/security-managers": { + "/orgs/{org}/rulesets/rule-suites": { "get": { - "summary": "List security manager teams", - "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the \"[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)\" endpoints instead.", + "summary": "List organization rule suites", + "description": "Lists suites of rule evaluations at the organization level.\nFor more information, see \"[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets).\"", "tags": [ - "orgs" + "repos" ], - "operationId": "orgs/list-security-manager-teams", + "operationId": "repos/get-org-rule-suites", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/security-managers#list-security-manager-teams" + "url": "https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites" }, "parameters": [ { @@ -162230,6 +155749,80 @@ "schema": { "type": "string" } + }, + { + "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 to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned.", + "in": "query", + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + { + "name": "repository_name", + "description": "The name of the repository to filter on.", + "in": "query", + "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": "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" + } + }, + { + "name": "rule_suite_result", + "description": "The rule suite results to filter on. When specified, only suites with this result will be returned.", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "pass", + "fail", + "bypass", + "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", + "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": { @@ -162238,521 +155831,152 @@ "content": { "application/json": { "schema": { + "title": "Rule Suites", + "description": "Response", "type": "array", "items": { - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] + "description": "The unique identifier of the rule insight." }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] + "actor_id": { + "type": "integer", + "description": "The number that identifies the user." }, - "members_url": { + "actor_name": { "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] + "description": "The handle for the GitHub user account." }, - "name": { - "description": "Name of the team", + "before_sha": { "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] + "description": "The first commit sha before the push evaluation." }, - "permission": { - "description": "Permission that the team will have for its repositories", + "after_sha": { "type": "string", - "examples": [ - "admin" - ] + "description": "The last commit sha in the push evaluation." }, - "privacy": { - "description": "The level of privacy this team should have", + "ref": { "type": "string", - "examples": [ - "closed" - ] + "description": "The ref name that the evaluation ran on." }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] + "repository_id": { + "type": "integer", + "description": "The ID of the repository associated with the rule evaluation." }, - "html_url": { + "repository_name": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] + "description": "The name of the repository without the `.git` extension." }, - "repositories_url": { + "pushed_at": { "type": "string", - "format": "uri", + "format": "date-time", "examples": [ - "https://api.github.com/organizations/1/team/1/repos" + "2011-01-26T19:06:43Z" ] }, - "slug": { + "result": { "type": "string", - "examples": [ - "justice-league" - ] + "enum": [ + "pass", + "fail", + "bypass" + ], + "description": "The result of the rule evaluations for rules with the `active` enforcement status." }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "evaluation_result": { "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] + "enum": [ + "pass", + "fail", + "bypass" + ], + "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`." } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] + } } }, "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 + "id": 21, + "actor_id": 12, + "actor_name": "octocat", + "before_sha": "893f768e172fb1bc9c5d6f3dd48557e45f14e01d", + "after_sha": "dedd88641a362b6b4ea872da4847d6131a164d01", + "ref": "refs/heads/i-see-everything", + "repository_id": 404, + "repository_name": "octo-repo", + "pushed_at": "2023-07-06T08:43:03Z", + "result": "bypass" + }, + { + "id": 25, + "actor_id": 11, + "actor_name": "not-octocat", + "before_sha": "48994e4e01ccc943624c6231f172702b82b233cc", + "after_sha": "ecfd5a1025fa271a33ca5608d089476a2df3c9a1", + "ref": "refs/heads/i-am-everything", + "repository_id": 404, + "repository_name": "octo-repo", + "pushed_at": "2023-07-07T08:43:03Z", + "result": "pass", + "evaluation_result": "fail" } ] } } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [], - "category": "orgs", - "subcategory": "security-managers", - "deprecationDate": "2024-12-01", - "removalDate": "2026-01-01" - }, - "deprecated": true - } - }, - "/orgs/{org}/security-managers/teams/{team_slug}": { - "put": { - "summary": "Add a security manager team", - "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the \"[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)\" endpoints instead.", - "tags": [ - "orgs" - ], - "operationId": "orgs/add-security-manager-team", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/security-managers#add-a-security-manager-team" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [], - "category": "orgs", - "subcategory": "security-managers", - "deprecationDate": "2024-12-01", - "removalDate": "2026-01-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Remove a security manager team", - "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the \"[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)\" endpoints instead.", - "tags": [ - "orgs" - ], - "operationId": "orgs/remove-security-manager-team", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/security-managers#remove-a-security-manager-team" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [], - "category": "orgs", - "subcategory": "security-managers", - "deprecationDate": "2024-12-01", - "removalDate": "2026-01-01" - }, - "deprecated": true - } - }, - "/orgs/{org}/settings/billing/actions": { - "get": { - "summary": "Get GitHub Actions billing for an organization", - "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 returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint.", - "operationId": "billing/get-github-actions-billing-org", - "tags": [ - "billing" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/billing/billing#get-github-actions-billing-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": { - "total_minutes_used": { - "type": "integer", - "description": "The sum of the free and paid GitHub Actions minutes used." + "message": { + "type": "string" }, - "total_paid_minutes_used": { - "type": "integer", - "description": "The total paid GitHub Actions minutes used." + "documentation_url": { + "type": "string" }, - "included_minutes": { - "type": "integer", - "description": "The amount of free GitHub Actions minutes available." + "url": { + "type": "string" }, - "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 - } + "status": { + "type": "string" } } } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "billing", - "subcategory": "billing" - } - } - }, - "/orgs/{org}/settings/billing/packages": { - "get": { - "summary": "Get GitHub Packages billing for an organization", - "description": "Gets the free and paid storage used for GitHub Packages in gigabytes.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint.", - "operationId": "billing/get-github-packages-billing-org", - "tags": [ - "billing" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/billing/billing#get-github-packages-billing-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", + }, + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "total_gigabytes_bandwidth_used": { - "type": "integer", - "description": "Sum of the free and paid storage space (GB) for GitHuub Packages." - }, - "total_paid_gigabytes_bandwidth_used": { - "type": "integer", - "description": "Total paid storage space (GB) for GitHuub Packages." + "message": { + "type": "string" }, - "included_gigabytes_bandwidth": { - "type": "integer", - "description": "Free storage space (GB) for GitHub Packages." - } - }, - "required": [ - "total_gigabytes_bandwidth_used", - "total_paid_gigabytes_bandwidth_used", - "included_gigabytes_bandwidth" - ] - }, - "examples": { - "default": { - "value": { - "total_gigabytes_bandwidth_used": 50, - "total_paid_gigabytes_bandwidth_used": 40, - "included_gigabytes_bandwidth": 10 - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "billing", - "subcategory": "billing" - } - } - }, - "/orgs/{org}/settings/billing/shared-storage": { - "get": { - "summary": "Get shared storage billing for an organization", - "description": "Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint.", - "operationId": "billing/get-shared-storage-billing-org", - "tags": [ - "billing" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/billing/billing#get-shared-storage-billing-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": { - "days_left_in_billing_cycle": { - "type": "integer", - "description": "Numbers of days left in billing cycle." + "documentation_url": { + "type": "string" }, - "estimated_paid_storage_for_month": { - "type": "integer", - "description": "Estimated storage space (GB) used in billing cycle." + "url": { + "type": "string" }, - "estimated_storage_for_month": { - "type": "integer", - "description": "Estimated sum of free and paid storage space (GB) used in billing cycle." - } - }, - "required": [ - "days_left_in_billing_cycle", - "estimated_paid_storage_for_month", - "estimated_storage_for_month" - ] - }, - "examples": { - "default": { - "value": { - "days_left_in_billing_cycle": 20, - "estimated_paid_storage_for_month": 15, - "estimated_storage_for_month": 40 + "status": { + "type": "string" } } } @@ -162762,23 +155986,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "billing", - "subcategory": "billing" + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "rule-suites" } } }, - "/orgs/{org}/settings/network-configurations": { + "/orgs/{org}/rulesets/rule-suites/{rule_suite_id}": { "get": { - "summary": "List hosted compute network configurations for an organization", - "description": "Lists all hosted compute network configurations configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint.", + "summary": "Get an organization rule suite", + "description": "Gets information about a suite of rule evaluations from within an organization.\nFor more information, see \"[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets).\"", "tags": [ - "hosted-compute" + "repos" ], - "operationId": "hosted-compute/list-network-configurations-for-org", + "operationId": "repos/get-org-rule-suite", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/network-configurations#list-hosted-compute-network-configurations-for-an-organization" + "url": "https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite" }, "parameters": [ { @@ -162791,21 +156015,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", - "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": "rule_suite_id", + "description": "The unique identifier of the rule suite result.\nTo get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites)\nfor repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites)\nfor organizations.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" } } ], @@ -162815,72 +156030,135 @@ "content": { "application/json": { "schema": { + "title": "Rule Suite", + "description": "Response", "type": "object", - "required": [ - "total_count", - "network_configurations" - ], "properties": { - "total_count": { - "type": "integer" + "id": { + "type": "integer", + "description": "The unique identifier of the rule insight." }, - "network_configurations": { + "actor_id": { + "type": [ + "integer", + "null" + ], + "description": "The number that identifies the user." + }, + "actor_name": { + "type": [ + "string", + "null" + ], + "description": "The handle for the GitHub user account." + }, + "before_sha": { + "type": "string", + "description": "The first commit sha before the push evaluation." + }, + "after_sha": { + "type": "string", + "description": "The last commit sha in the push evaluation." + }, + "ref": { + "type": "string", + "description": "The ref name that the evaluation ran on." + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository associated with the rule evaluation." + }, + "repository_name": { + "type": "string", + "description": "The name of the repository without the `.git` extension." + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "result": { + "type": "string", + "enum": [ + "pass", + "fail", + "bypass" + ], + "description": "The result of the rule evaluations for rules with the `active` enforcement status." + }, + "evaluation_result": { + "type": [ + "string", + "null" + ], + "enum": [ + "pass", + "fail", + "bypass", + null + ], + "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. Null if no rules with `evaluate` enforcement status were run." + }, + "rule_evaluations": { "type": "array", + "description": "Details on the evaluated rules.", "items": { - "title": "Hosted compute network configuration", - "description": "A hosted compute network configuration.", "type": "object", "properties": { - "id": { - "description": "The unique identifier of the network configuration.", - "type": "string", - "examples": [ - "123ABC456DEF789" - ] + "rule_source": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of rule source." + }, + "id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the rule source." + }, + "name": { + "type": [ + "string", + "null" + ], + "description": "The name of the rule source." + } + } }, - "name": { - "description": "The name of the network configuration.", + "enforcement": { "type": "string", - "examples": [ - "my-network-configuration" - ] + "enum": [ + "active", + "evaluate", + "deleted ruleset" + ], + "description": "The enforcement level of this rule source." }, - "compute_service": { - "description": "The hosted compute service the network configuration supports.", + "result": { "type": "string", "enum": [ - "none", - "actions", - "codespaces" - ] + "pass", + "fail" + ], + "description": "The result of the evaluation of the individual rule." }, - "network_settings_ids": { - "description": "The unique identifier of each network settings in the configuration.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "123ABC456DEF789" - ] + "rule_type": { + "type": "string", + "description": "The type of rule." }, - "created_on": { - "description": "The time at which the network configuration was created, in ISO 8601 format.", + "details": { "type": [ "string", "null" ], - "format": "date-time", - "examples": [ - "2024-04-26T11:31:07Z" - ] + "description": "The detailed failure message for the rule. Null if the rule passed." } - }, - "required": [ - "id", - "name", - "created_on" - ] + } } } } @@ -162888,193 +156166,100 @@ "examples": { "default": { "value": { - "total_count": 2, - "network_configurations": [ + "id": 21, + "actor_id": 12, + "actor_name": "octocat", + "before_sha": "893f768e172fb1bc9c5d6f3dd48557e45f14e01d", + "after_sha": "dedd88641a362b6b4ea872da4847d6131a164d01", + "ref": "refs/heads/i-see-everything", + "repository_id": 404, + "repository_name": "octo-repo", + "pushed_at": "2023-07-06T08:43:03Z", + "result": "bypass", + "evaluation_result": "fail", + "rule_evaluations": [ { - "id": "123456789ABCDEF", - "name": "My network configuration", - "compute_service": "actions", - "network_settings_ids": [ - "23456789ABDCEF1", - "3456789ABDCEF12" - ], - "created_on": "2022-10-09T23:39:01Z" + "rule_source": { + "type": "ruleset", + "id": 2, + "name": "Author email must be a GitHub email address" + }, + "enforcement": "active", + "result": "pass", + "rule_type": "commit_author_email_pattern" }, { - "id": "456789ABDCEF123", - "name": "My other configuration", - "compute_service": "none", - "network_settings_ids": [ - "56789ABDCEF1234", - "6789ABDCEF12345" - ], - "created_on": "2023-04-26T15:23:37Z" + "rule_source": { + "type": "protected_branch" + }, + "enforcement": "active", + "result": "fail", + "rule_type": "pull_request", + "details": "Changes must be made through a pull request." + }, + { + "rule_source": { + "type": "ruleset", + "id": 3, + "name": "Evaluate commit message pattern" + }, + "enforcement": "evaluate", + "result": "fail", + "rule_type": "commit_message_pattern" } ] } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "network-configurations" - } - }, - "post": { - "summary": "Create a hosted compute network configuration for an organization", - "description": "Creates a hosted compute network configuration for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint.", - "tags": [ - "hosted-compute" - ], - "operationId": "hosted-compute/create-network-configuration-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/network-configurations#create-a-hosted-compute-network-configuration-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 network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.", - "type": "string" - }, - "compute_service": { - "description": "The hosted compute service to use for the network configuration.", - "type": "string", - "enum": [ - "none", - "actions" - ] - }, - "network_settings_ids": { - "type": "array", - "minItems": 1, - "maxItems": 1, - "description": "The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified.", - "items": { + }, + "404": { + "description": "Resource not found", + "content": { + "application/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": [ - "name", - "network_settings_ids" - ] - }, - "examples": { - "default": { - "value": { - "name": "my-network-configuration", - "network_settings_ids": [ - "23456789ABDCEF1" - ], - "compute_service": "actions" - } } } } - } - }, - "responses": { - "201": { - "description": "Response", + }, + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { - "title": "Hosted compute network configuration", - "description": "A hosted compute network configuration.", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "id": { - "description": "The unique identifier of the network configuration.", - "type": "string", - "examples": [ - "123ABC456DEF789" - ] - }, - "name": { - "description": "The name of the network configuration.", - "type": "string", - "examples": [ - "my-network-configuration" - ] + "message": { + "type": "string" }, - "compute_service": { - "description": "The hosted compute service the network configuration supports.", - "type": "string", - "enum": [ - "none", - "actions", - "codespaces" - ] + "documentation_url": { + "type": "string" }, - "network_settings_ids": { - "description": "The unique identifier of each network settings in the configuration.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "123ABC456DEF789" - ] + "url": { + "type": "string" }, - "created_on": { - "description": "The time at which the network configuration was created, in ISO 8601 format.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2024-04-26T11:31:07Z" - ] - } - }, - "required": [ - "id", - "name", - "created_on" - ] - }, - "examples": { - "default": { - "value": { - "id": "123456789ABCDEF", - "name": "My network configuration", - "compute_service": "actions", - "network_settings_ids": [ - "23456789ABDCEF1", - "3456789ABDCEF12" - ], - "created_on": "2022-10-09T23:39:01Z" + "status": { + "type": "string" } } } @@ -163086,21 +156271,27 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", - "subcategory": "network-configurations" + "subcategory": "rule-suites" } } }, - "/orgs/{org}/settings/network-configurations/{network_configuration_id}": { + "/orgs/{org}/rulesets/{ruleset_id}": { "get": { - "summary": "Get a hosted compute network configuration for an organization", - "description": "Gets a hosted compute network configuration configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint.", + "summary": "Get an organization repository ruleset", + "description": "Get a repository ruleset for an organization.\n\n**Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user\nmaking the API request has write access to the ruleset.", "tags": [ - "hosted-compute" + "repos" ], - "operationId": "hosted-compute/get-network-configuration-for-org", + "operationId": "repos/get-org-ruleset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization" + "url": "https://docs.github.com/rest/orgs/rules#get-an-organization-repository-ruleset" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "rules" }, "parameters": [ { @@ -163113,12 +156304,12 @@ } }, { - "name": "network_configuration_id", - "description": "Unique identifier of the hosted compute network configuration.", + "name": "ruleset_id", + "description": "The ID of the ruleset.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], @@ -163128,969 +156319,1316 @@ "content": { "application/json": { "schema": { - "title": "Hosted compute network configuration", - "description": "A hosted compute network configuration.", + "title": "Repository ruleset", "type": "object", + "description": "A set of rules to apply when specified conditions are met.", + "required": [ + "id", + "name", + "source", + "enforcement" + ], "properties": { "id": { - "description": "The unique identifier of the network configuration.", + "type": "integer", + "description": "The ID of the ruleset" + }, + "name": { "type": "string", - "examples": [ - "123ABC456DEF789" + "description": "The name of the ruleset" + }, + "target": { + "type": "string", + "description": "The target of the ruleset", + "enum": [ + "branch", + "tag", + "push", + "repository" ] }, - "name": { - "description": "The name of the network configuration.", + "source_type": { "type": "string", - "examples": [ - "my-network-configuration" + "description": "The type of the source of the ruleset", + "enum": [ + "Repository", + "Organization", + "Enterprise" ] }, - "compute_service": { - "description": "The hosted compute service the network configuration supports.", + "source": { + "type": "string", + "description": "The name of the source" + }, + "enforcement": { "type": "string", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).", "enum": [ - "none", - "actions", - "codespaces" + "disabled", + "active", + "evaluate" ] }, - "network_settings_ids": { - "description": "The unique identifier of each network settings in the configuration.", + "bypass_actors": { "type": "array", + "description": "The actors that can bypass the rules in this ruleset", "items": { - "type": "string" - }, - "examples": [ - "123ABC456DEF789" - ] - }, - "created_on": { - "description": "The time at which the network configuration was created, in ISO 8601 format.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2024-04-26T11:31:07Z" - ] - } - }, - "required": [ - "id", - "name", - "created_on" - ] - }, - "examples": { - "default": { - "value": { - "id": "123456789ABCDEF", - "name": "My network configuration", - "compute_service": "actions", - "network_settings_ids": [ - "23456789ABDCEF1", - "3456789ABDCEF12" - ], - "created_on": "2022-10-09T23:39:01Z" - } - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "network-configurations" - } - }, - "patch": { - "summary": "Update a hosted compute network configuration for an organization", - "description": "Updates a hosted compute network configuration for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint.", - "tags": [ - "hosted-compute" - ], - "operationId": "hosted-compute/update-network-configuration-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/network-configurations#update-a-hosted-compute-network-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": "network_configuration_id", - "description": "Unique identifier of the hosted compute network configuration.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "description": "Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.", - "type": "string" - }, - "compute_service": { - "description": "The hosted compute service to use for the network configuration.", - "type": "string", - "enum": [ - "none", - "actions" - ] - }, - "network_settings_ids": { - "type": "array", - "minItems": 0, - "maxItems": 1, - "description": "The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified.", - "items": { - "type": "string" - } - } - } - }, - "examples": { - "default": { - "value": { - "name": "my-network-configuration", - "network_settings_ids": [ - "23456789ABDCEF1" - ], - "compute_service": "actions" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Hosted compute network configuration", - "description": "A hosted compute network configuration.", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the network configuration.", - "type": "string", - "examples": [ - "123ABC456DEF789" - ] - }, - "name": { - "description": "The name of the network configuration.", - "type": "string", - "examples": [ - "my-network-configuration" - ] + "title": "Repository Ruleset Bypass Actor", + "type": "object", + "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_type" + ], + "properties": { + "actor_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + }, + "actor_type": { + "type": "string", + "enum": [ + "Integration", + "OrganizationAdmin", + "RepositoryRole", + "Team", + "DeployKey" + ], + "description": "The type of actor that can bypass a ruleset." + }, + "bypass_mode": { + "type": "string", + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", + "enum": [ + "always", + "pull_request" + ], + "default": "always" + } + } + } }, - "compute_service": { - "description": "The hosted compute service the network configuration supports.", + "current_user_can_bypass": { "type": "string", + "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", "enum": [ - "none", - "actions", - "codespaces" - ] - }, - "network_settings_ids": { - "description": "The unique identifier of each network settings in the configuration.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "123ABC456DEF789" - ] - }, - "created_on": { - "description": "The time at which the network configuration was created, in ISO 8601 format.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2024-04-26T11:31:07Z" - ] - } - }, - "required": [ - "id", - "name", - "created_on" - ] - }, - "examples": { - "default": { - "value": { - "id": "123456789ABCDEF", - "name": "My network configuration", - "compute_service": "actions", - "network_settings_ids": [ - "23456789ABDCEF1", - "3456789ABDCEF12" - ], - "created_on": "2022-10-09T23:39:01Z" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "network-configurations" - } - }, - "delete": { - "summary": "Delete a hosted compute network configuration from an organization", - "description": "Deletes a hosted compute network configuration from an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint.", - "tags": [ - "hosted-compute" - ], - "operationId": "hosted-compute/delete-network-configuration-from-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "network_configuration_id", - "description": "Unique identifier of the hosted compute network configuration.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "network-configurations" - } - } - }, - "/orgs/{org}/settings/network-settings/{network_settings_id}": { - "get": { - "summary": "Get a hosted compute network settings resource for an organization", - "description": "Gets a hosted compute network settings resource configured for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint.", - "tags": [ - "hosted-compute" - ], - "operationId": "hosted-compute/get-network-settings-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "network_settings_id", - "description": "Unique identifier of the hosted compute network settings.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Hosted compute network settings resource", - "description": "A hosted compute network settings resource.", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the network settings resource.", - "type": "string", - "examples": [ - "220F78DACB92BBFBC5E6F22DE1CCF52309D" - ] - }, - "network_configuration_id": { - "description": "The identifier of the network configuration that is using this settings resource.", - "type": "string", - "examples": [ - "934E208B3EE0BD60CF5F752C426BFB53562" + "always", + "pull_requests_only", + "never" ] }, - "name": { - "description": "The name of the network settings resource.", - "type": "string", - "examples": [ - "my-network-settings" - ] + "node_id": { + "type": "string" }, - "subnet_id": { - "description": "The subnet this network settings resource is configured for.", - "type": "string", - "examples": [ - "/subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet" - ] + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "The URL of the ruleset" + } + } + }, + "html": { + "type": [ + "object", + "null" + ], + "properties": { + "href": { + "type": "string", + "description": "The html URL of the ruleset" + } + } + } + } }, - "region": { - "description": "The location of the subnet this network settings resource is configured for.", - "type": "string", - "examples": [ - "eastus" - ] - } - }, - "required": [ - "id", - "name", - "subnet_id", - "region" - ] - }, - "examples": { - "default": { - "value": { - "id": "220F78DACB92BBFBC5E6F22DE1CCF52309D", - "network_configuration_id": "934E208B3EE0BD60CF5F752C426BFB53562", - "name": "my_network_settings", - "subnet_id": "/subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet", - "region": "eastus" - } - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "network-configurations" - } - } - }, - "/orgs/{org}/team/{team_slug}/copilot/metrics": { - "get": { - "summary": "Get Copilot metrics for a team", - "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 team had **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 containing the team within GitHub settings.\nOnly organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team.\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-team", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "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", - "null" - ], - "description": "Usage metrics for Copilot editor code completions in the IDE.", - "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": { + "conditions": { + "anyOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { "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." + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } }, - "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." + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } } } } - }, - "editors": { - "type": "array", - "items": { + } + }, + { + "title": "Organization ruleset conditions", + "type": "object", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", + "oneOf": [ + { "type": "object", - "description": "Copilot code completion metrics for active editors.", - "additionalProperties": true, - "properties": { - "name": { - "type": "string", - "description": "Name of the given editor." + "title": "repository_name_and_ref_name", + "description": "Conditions to target repositories by name and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } }, - "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." + { + "title": "Repository ruleset conditions for repository names", + "type": "object", + "description": "Parameters for a repository name condition", + "properties": { + "repository_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + }, + "protected": { + "type": "boolean", + "description": "Whether renaming of target repositories is prevented." + } + } + } + }, + "required": [ + "repository_name" + ] + } + ] + }, + { + "type": "object", + "title": "repository_id_and_ref_name", + "description": "Conditions to target repositories by id and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } }, - "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", - "null" - ], - "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." + { + "title": "Repository ruleset conditions for repository IDs", + "type": "object", + "description": "Parameters for a repository ID condition", + "properties": { + "repository_id": { + "type": "object", + "properties": { + "repository_ids": { + "type": "array", + "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" + } + } + } + } + }, + "required": [ + "repository_id" + ] + } + ] + }, + { + "type": "object", + "title": "repository_property_and_ref_name", + "description": "Conditions to target repositories by property and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Repository ruleset conditions for repository properties", + "type": "object", + "description": "Parameters for a repository property condition", + "properties": { + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } }, - "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." + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } }, - "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": [ + "name", + "property_values" + ] } } } } - } + }, + "required": [ + "repository_property" + ] } - } + ] } - } + ] } - }, - "copilot_ide_chat": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot Chat in the IDE.", - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat in the IDE." + ], + "type": [ + "null", + "object" + ] + }, + "rules": { + "type": "array", + "items": { + "title": "Repository Rule", + "type": "object", + "description": "A repository rule.", + "oneOf": [ + { + "title": "creation", + "description": "Only allow users with bypass permission to create matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "creation" + ] + } + } }, - "editors": { - "type": "array", - "items": { - "type": "object", - "description": "Copilot Chat metrics, for active editors.", - "properties": { - "name": { - "type": "string", - "description": "Name of the given editor." + { + "title": "update", + "description": "Only allow users with bypass permission to update matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "update" + ] + }, + "parameters": { + "type": "object", + "properties": { + "update_allows_fetch_and_merge": { + "type": "boolean", + "description": "Branch can pull changes from its upstream repository" + } }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who prompted Copilot Chat in the specified editor." + "required": [ + "update_allows_fetch_and_merge" + ] + } + } + }, + { + "title": "deletion", + "description": "Only allow users with bypass permissions to delete matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "deletion" + ] + } + } + }, + { + "title": "required_linear_history", + "description": "Prevent merge commits from being pushed to matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_linear_history" + ] + } + } + }, + { + "title": "merge_queue", + "description": "Merges must be performed via a merge queue.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "merge_queue" + ] + }, + "parameters": { + "type": "object", + "properties": { + "check_response_timeout_minutes": { + "type": "integer", + "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", + "minimum": 1, + "maximum": 360 + }, + "grouping_strategy": { + "type": "string", + "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", + "enum": [ + "ALLGREEN", + "HEADGREEN" + ] + }, + "max_entries_to_build": { + "type": "integer", + "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", + "minimum": 0, + "maximum": 100 + }, + "max_entries_to_merge": { + "type": "integer", + "description": "The maximum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "merge_method": { + "type": "string", + "description": "Method to use when merging changes from queued pull requests.", + "enum": [ + "MERGE", + "SQUASH", + "REBASE" + ] + }, + "min_entries_to_merge": { + "type": "integer", + "description": "The minimum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "min_entries_to_merge_wait_minutes": { + "type": "integer", + "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", + "minimum": 0, + "maximum": 360 + } }, - "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", - "null" - ], - "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." + "required": [ + "check_response_timeout_minutes", + "grouping_strategy", + "max_entries_to_build", + "max_entries_to_merge", + "merge_method", + "min_entries_to_merge", + "min_entries_to_merge_wait_minutes" + ] + } + } + }, + { + "title": "required_deployments", + "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_deployments" + ] + }, + "parameters": { + "type": "object", + "properties": { + "required_deployment_environments": { + "type": "array", + "description": "The environments that must be successfully deployed to before branches can be merged.", + "items": { + "type": "string" + } + } + }, + "required": [ + "required_deployment_environments" + ] + } + } + }, + { + "title": "required_signatures", + "description": "Commits pushed to matching refs must have verified signatures.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_signatures" + ] + } + } + }, + { + "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.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "pull_request" + ] + }, + "parameters": { + "type": "object", + "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", + "items": { + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "automatic_copilot_code_review_enabled": { + "type": "boolean", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean", + "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." + }, + "require_code_owner_review": { + "type": "boolean", + "description": "Require an approving review in pull requests that modify files that have a designated code owner." + }, + "require_last_push_approval": { + "type": "boolean", + "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." + }, + "required_approving_review_count": { + "type": "integer", + "description": "The number of approving reviews that are required before a pull request can be merged.", + "minimum": 0, + "maximum": 10 + }, + "required_review_thread_resolution": { + "type": "boolean", + "description": "All conversations on code must be resolved before a pull request can be merged." + } + }, + "required": [ + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "require_last_push_approval", + "required_approving_review_count", + "required_review_thread_resolution" + ] + } + } + }, + { + "title": "required_status_checks", + "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_status_checks" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "required_status_checks": { + "type": "array", + "description": "Status checks that are required.", + "items": { + "title": "StatusCheckConfiguration", + "description": "Required status check", + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "The status check context name that must be present on the commit." + }, + "integration_id": { + "type": "integer", + "description": "The optional integration ID that this status check must originate from." + } }, - "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." - } + "required": [ + "context" + ] } + }, + "strict_required_status_checks_policy": { + "type": "boolean", + "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." } - } + }, + "required": [ + "required_status_checks", + "strict_required_status_checks_policy" + ] } } - } - } - }, - "copilot_dotcom_chat": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot Chat in GitHub.com", - "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'." + { + "title": "non_fast_forward", + "description": "Prevent users with push access from force pushing to refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "non_fast_forward" + ] + } + } + }, + { + "title": "commit_message_pattern", + "description": "Parameters to be used for the commit_message_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_message_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "commit_author_email_pattern", + "description": "Parameters to be used for the commit_author_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_author_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } }, - "custom_model_training_date": { - "type": [ - "string", - "null" - ], - "description": "The training date for the custom model (if applicable)." + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "committer_email_pattern", + "description": "Parameters to be used for the committer_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "committer_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } }, - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "branch_name_pattern", + "description": "Parameters to be used for the branch_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "branch_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } }, - "total_chats": { - "type": "integer", - "description": "Total number of chats initiated by users on github.com." - } + "required": [ + "operator", + "pattern" + ] } } - } - } - }, - "copilot_dotcom_pull_requests": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot for pull requests.", - "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" + { + "title": "tag_name_pattern", + "description": "Parameters to be used for the tag_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tag_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } }, - "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", - "null" - ], - "description": "The training date for the custom model." + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } + }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } }, - "total_pr_summaries_created": { - "type": "integer", - "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } }, - "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": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] } } - } + }, + "required": [ + "code_scanning_tools" + ] } } } - } + ] } }, - "required": [ - "date" - ], - "additionalProperties": true + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } } }, "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 - } + "value": { + "id": 21, + "name": "super cool ruleset", + "target": "branch", + "source_type": "Organization", + "source": "my-org", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" ], - "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 - } - ] - } + "exclude": [ + "refs/heads/dev*" ] }, - "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 - } - ] + "repository_name": { + "include": [ + "important_repository", + "another_important_repository" + ], + "exclude": [ + "unimportant_repository" + ], + "protected": true + } + }, + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" + } + } + ], + "node_id": "RRS_lACkVXNlcgQB", + "_links": { + "self": { + "href": "https://api.github.com/orgs/my-org/rulesets/21" }, - "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 - } - ] - } - ] + "html": { + "href": "https://github.com/organizations/my-org/settings/rules/21" } - } - ] + }, + "created_at": "2023-08-15T08:43:03Z", + "updated_at": "2023-09-23T16:29:47Z" + } } } } } }, - "500": { - "description": "Internal Error", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -164115,60 +157653,8 @@ } } }, - "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.", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -164193,26 +157679,24 @@ } } } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-metrics" } - } - }, - "/orgs/{org}/teams": { - "get": { - "summary": "List teams", - "description": "Lists all teams in an organization that are visible to the authenticated user.", + }, + "put": { + "summary": "Update an organization repository ruleset", + "description": "Update a ruleset for an organization.", "tags": [ - "teams" + "repos" ], - "operationId": "teams/list", + "operationId": "repos/update-org-ruleset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#list-teams" + "url": "https://docs.github.com/rest/orgs/rules#update-an-organization-repository-ruleset" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "rules" }, "parameters": [ { @@ -164225,1126 +157709,2456 @@ } }, { - "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": "ruleset_id", + "description": "The ID of the ruleset.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" } } ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", + "requestBody": { + "description": "Request body", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the ruleset." + }, + "target": { + "type": "string", + "description": "The target of the ruleset", + "enum": [ + "branch", + "tag", + "push", + "repository" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).", + "enum": [ + "disabled", + "active", + "evaluate" + ] + }, + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "title": "Repository Ruleset Bypass Actor", + "type": "object", + "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_type" + ], + "properties": { + "actor_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + }, + "actor_type": { + "type": "string", + "enum": [ + "Integration", + "OrganizationAdmin", + "RepositoryRole", + "Team", + "DeployKey" + ], + "description": "The type of actor that can bypass a ruleset." + }, + "bypass_mode": { + "type": "string", + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", + "enum": [ + "always", + "pull_request" + ], + "default": "always" + } + } + } + }, + "conditions": { + "title": "Organization ruleset conditions", "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", + "oneOf": [ + { "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" + "title": "repository_name_and_ref_name", + "description": "Conditions to target repositories by name and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } }, - "admin": { - "type": "boolean" + { + "title": "Repository ruleset conditions for repository names", + "type": "object", + "description": "Parameters for a repository name condition", + "properties": { + "repository_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + }, + "protected": { + "type": "boolean", + "description": "Whether renaming of target repositories is prevented." + } + } + } + }, + "required": [ + "repository_name" + ] } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" ] }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" + { + "type": "object", + "title": "repository_id_and_ref_name", + "description": "Conditions to target repositories by id and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Repository ruleset conditions for repository IDs", + "type": "object", + "description": "Parameters for a repository ID condition", + "properties": { + "repository_id": { + "type": "object", + "properties": { + "repository_ids": { + "type": "array", + "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" + } + } + } + } + }, + "required": [ + "repository_id" + ] + } ] }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ + { + "type": "object", + "title": "repository_property_and_ref_name", + "description": "Conditions to target repositories by property and refs by name", + "allOf": [ { - "type": "null" + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } }, { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", + "title": "Repository ruleset conditions for repository properties", "type": "object", + "description": "Parameters for a repository property condition", "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + } + } } }, "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" + "repository_property" ] } ] } - }, - "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" - } - } - } - }, - "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": "teams", - "subcategory": "teams" - } - }, - "post": { - "summary": "Create a team", - "description": "To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://docs.github.com/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/about-teams)\".", - "tags": [ - "teams" - ], - "operationId": "teams/create", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#create-a-team" - }, - "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 team." - }, - "description": { - "type": "string", - "description": "The description of the team." - }, - "maintainers": { - "type": "array", - "description": "List GitHub usernames for organization members who will become team maintainers.", - "items": { - "type": "string" - } }, - "repo_names": { + "rules": { + "description": "An array of rules within the ruleset.", "type": "array", - "description": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.", "items": { - "type": "string" - } - }, - "privacy": { - "type": "string", - "description": "The level of privacy this team should have. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \nDefault: `secret` \n**For a parent or child team:** \n * `closed` - visible to all members of this organization. \nDefault for child team: `closed`", - "enum": [ - "secret", - "closed" - ] - }, - "notification_setting": { - "type": "string", - "description": "The notification setting the team has chosen. The options are: \n * `notifications_enabled` - team members receive notifications when the team is @mentioned. \n * `notifications_disabled` - no one receives notifications. \nDefault: `notifications_enabled`", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ] - }, - "permission": { - "type": "string", - "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.", - "enum": [ - "pull", - "push" - ], - "default": "pull" - }, - "parent_team_id": { - "type": "integer", - "description": "The ID of a team to set as the parent team." - } - }, - "required": [ - "name" - ] - }, - "examples": { - "default": { - "value": { - "name": "Justice League", - "description": "A great team", - "permission": "push", - "notification_setting": "notifications_enabled", - "privacy": "closed" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Full Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Developers" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ], - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ], - "examples": [ - "notifications_enabled" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "push" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "parent": { - "anyOf": [ + "title": "Repository Rule", + "type": "object", + "description": "A repository rule.", + "oneOf": [ { - "type": "null" + "title": "creation", + "description": "Only allow users with bypass permission to create matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "creation" + ] + } + } }, { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", + "title": "update", + "description": "Only allow users with bypass permission to update matching refs.", "type": "object", + "required": [ + "type" + ], "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 + "type": { + "type": "string", + "enum": [ + "update" ] }, - "node_id": { + "parameters": { + "type": "object", + "properties": { + "update_allows_fetch_and_merge": { + "type": "boolean", + "description": "Branch can pull changes from its upstream repository" + } + }, + "required": [ + "update_allows_fetch_and_merge" + ] + } + } + }, + { + "title": "deletion", + "description": "Only allow users with bypass permissions to delete matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "examples": [ - "MDQ6VGVhbTE=" + "enum": [ + "deletion" + ] + } + } + }, + { + "title": "required_linear_history", + "description": "Prevent merge commits from being pushed to matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_linear_history" + ] + } + } + }, + { + "title": "required_deployments", + "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_deployments" ] }, - "url": { - "description": "URL for the team", + "parameters": { + "type": "object", + "properties": { + "required_deployment_environments": { + "type": "array", + "description": "The environments that must be successfully deployed to before branches can be merged.", + "items": { + "type": "string" + } + } + }, + "required": [ + "required_deployment_environments" + ] + } + } + }, + { + "title": "required_signatures", + "description": "Commits pushed to matching refs must have verified signatures.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" + "enum": [ + "required_signatures" + ] + } + } + }, + { + "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.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "pull_request" ] }, - "members_url": { + "parameters": { + "type": "object", + "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", + "items": { + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "automatic_copilot_code_review_enabled": { + "type": "boolean", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean", + "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." + }, + "require_code_owner_review": { + "type": "boolean", + "description": "Require an approving review in pull requests that modify files that have a designated code owner." + }, + "require_last_push_approval": { + "type": "boolean", + "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." + }, + "required_approving_review_count": { + "type": "integer", + "description": "The number of approving reviews that are required before a pull request can be merged.", + "minimum": 0, + "maximum": 10 + }, + "required_review_thread_resolution": { + "type": "boolean", + "description": "All conversations on code must be resolved before a pull request can be merged." + } + }, + "required": [ + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "require_last_push_approval", + "required_approving_review_count", + "required_review_thread_resolution" + ] + } + } + }, + { + "title": "required_status_checks", + "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" + "enum": [ + "required_status_checks" ] }, - "name": { - "description": "Name of the team", + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "required_status_checks": { + "type": "array", + "description": "Status checks that are required.", + "items": { + "title": "StatusCheckConfiguration", + "description": "Required status check", + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "The status check context name that must be present on the commit." + }, + "integration_id": { + "type": "integer", + "description": "The optional integration ID that this status check must originate from." + } + }, + "required": [ + "context" + ] + } + }, + "strict_required_status_checks_policy": { + "type": "boolean", + "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." + } + }, + "required": [ + "required_status_checks", + "strict_required_status_checks_policy" + ] + } + } + }, + { + "title": "non_fast_forward", + "description": "Prevent users with push access from force pushing to refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "examples": [ - "Justice League" + "enum": [ + "non_fast_forward" + ] + } + } + }, + { + "title": "commit_message_pattern", + "description": "Parameters to be used for the commit_message_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_message_pattern" ] }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "commit_author_email_pattern", + "description": "Parameters to be used for the commit_author_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_author_email_pattern" ] }, - "permission": { - "description": "Permission that the team will have for its repositories", + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "committer_email_pattern", + "description": "Parameters to be used for the committer_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "examples": [ - "admin" + "enum": [ + "committer_email_pattern" ] }, - "privacy": { - "description": "The level of privacy this team should have", + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "branch_name_pattern", + "description": "Parameters to be used for the branch_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "examples": [ - "closed" + "enum": [ + "branch_name_pattern" ] }, - "notification_setting": { - "description": "The notification setting the team has set", + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "tag_name_pattern", + "description": "Parameters to be used for the tag_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "examples": [ - "notifications_enabled" + "enum": [ + "tag_name_pattern" ] }, - "html_url": { + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" + "enum": [ + "file_path_restriction" ] }, - "repositories_url": { + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" + "enum": [ + "max_file_path_length" ] }, - "slug": { + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "examples": [ - "justice-league" + "enum": [ + "file_extension_restriction" ] }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" ] } - }, + } + }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } } ] + } + } + } + }, + "examples": { + "default": { + "value": { + "name": "super cool ruleset", + "target": "branch", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] + }, + "repository_name": { + "include": [ + "important_repository", + "another_important_repository" + ], + "exclude": [ + "unimportant_repository" + ], + "protected": true + } }, - "members_count": { + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" + } + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Repository ruleset", + "type": "object", + "description": "A set of rules to apply when specified conditions are met.", + "required": [ + "id", + "name", + "source", + "enforcement" + ], + "properties": { + "id": { "type": "integer", - "examples": [ - 3 + "description": "The ID of the ruleset" + }, + "name": { + "type": "string", + "description": "The name of the ruleset" + }, + "target": { + "type": "string", + "description": "The target of the ruleset", + "enum": [ + "branch", + "tag", + "push", + "repository" ] }, - "repos_count": { - "type": "integer", - "examples": [ - 10 + "source_type": { + "type": "string", + "description": "The type of the source of the ruleset", + "enum": [ + "Repository", + "Organization", + "Enterprise" ] }, - "created_at": { + "source": { "type": "string", - "format": "date-time", - "examples": [ - "2017-07-14T16:53:42Z" + "description": "The name of the source" + }, + "enforcement": { + "type": "string", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).", + "enum": [ + "disabled", + "active", + "evaluate" ] }, - "updated_at": { + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "title": "Repository Ruleset Bypass Actor", + "type": "object", + "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_type" + ], + "properties": { + "actor_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + }, + "actor_type": { + "type": "string", + "enum": [ + "Integration", + "OrganizationAdmin", + "RepositoryRole", + "Team", + "DeployKey" + ], + "description": "The type of actor that can bypass a ruleset." + }, + "bypass_mode": { + "type": "string", + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", + "enum": [ + "always", + "pull_request" + ], + "default": "always" + } + } + } + }, + "current_user_can_bypass": { "type": "string", - "format": "date-time", - "examples": [ - "2017-08-17T12:37:15Z" + "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", + "enum": [ + "always", + "pull_requests_only", + "never" ] }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", + "node_id": { + "type": "string" + }, + "_links": { "type": "object", "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - }, - "name": { - "type": "string", - "examples": [ - "github" - ] - }, - "company": { - "type": "string", - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": "string", - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": "string", - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "github" - ] - }, - "is_verified": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_organization_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_repository_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "private_gists": { - "type": [ - "integer", - "null" - ], - "examples": [ - 81 - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ], - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ], - "examples": [ - 8 - ] + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "The URL of the ruleset" + } + } }, - "billing_email": { + "html": { "type": [ - "string", + "object", "null" ], - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "plan": { - "type": "object", "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" + "href": { + "type": "string", + "description": "The html URL of the ruleset" } - }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": [ - "string", - "null" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "members_allowed_repository_creation_type": { - "type": "string", - "examples": [ - "all" - ] - }, - "members_can_create_public_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_public_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] + } + } + } + }, + "conditions": { + "anyOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false + { + "title": "Organization ruleset conditions", + "type": "object", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", + "oneOf": [ + { + "type": "object", + "title": "repository_name_and_ref_name", + "description": "Conditions to target repositories by name and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Repository ruleset conditions for repository names", + "type": "object", + "description": "Parameters for a repository name condition", + "properties": { + "repository_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + }, + "protected": { + "type": "boolean", + "description": "Whether renaming of target repositories is prevented." + } + } + } + }, + "required": [ + "repository_name" + ] + } + ] + }, + { + "type": "object", + "title": "repository_id_and_ref_name", + "description": "Conditions to target repositories by id and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Repository ruleset conditions for repository IDs", + "type": "object", + "description": "Parameters for a repository ID condition", + "properties": { + "repository_id": { + "type": "object", + "properties": { + "repository_ids": { + "type": "array", + "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" + } + } + } + } + }, + "required": [ + "repository_id" + ] + } + ] + }, + { + "type": "object", + "title": "repository_property_and_ref_name", + "description": "Conditions to target repositories by property and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Repository ruleset conditions for repository properties", + "type": "object", + "description": "Parameters for a repository property condition", + "properties": { + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + } + } + } + }, + "required": [ + "repository_property" + ] + } + ] + } ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" } - }, - "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" + ], + "type": [ + "null", + "object" ] }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "rules": { + "type": "array", + "items": { + "title": "Repository Rule", + "type": "object", + "description": "A repository rule.", + "oneOf": [ + { + "title": "creation", + "description": "Only allow users with bypass permission to create matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "creation" + ] + } + } + }, + { + "title": "update", + "description": "Only allow users with bypass permission to update matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "update" + ] + }, + "parameters": { + "type": "object", + "properties": { + "update_allows_fetch_and_merge": { + "type": "boolean", + "description": "Branch can pull changes from its upstream repository" + } + }, + "required": [ + "update_allows_fetch_and_merge" + ] + } + } + }, + { + "title": "deletion", + "description": "Only allow users with bypass permissions to delete matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "deletion" + ] + } + } + }, + { + "title": "required_linear_history", + "description": "Prevent merge commits from being pushed to matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_linear_history" + ] + } + } + }, + { + "title": "merge_queue", + "description": "Merges must be performed via a merge queue.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "merge_queue" + ] + }, + "parameters": { + "type": "object", + "properties": { + "check_response_timeout_minutes": { + "type": "integer", + "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", + "minimum": 1, + "maximum": 360 + }, + "grouping_strategy": { + "type": "string", + "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", + "enum": [ + "ALLGREEN", + "HEADGREEN" + ] + }, + "max_entries_to_build": { + "type": "integer", + "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", + "minimum": 0, + "maximum": 100 + }, + "max_entries_to_merge": { + "type": "integer", + "description": "The maximum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "merge_method": { + "type": "string", + "description": "Method to use when merging changes from queued pull requests.", + "enum": [ + "MERGE", + "SQUASH", + "REBASE" + ] + }, + "min_entries_to_merge": { + "type": "integer", + "description": "The minimum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "min_entries_to_merge_wait_minutes": { + "type": "integer", + "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", + "minimum": 0, + "maximum": 360 + } + }, + "required": [ + "check_response_timeout_minutes", + "grouping_strategy", + "max_entries_to_build", + "max_entries_to_merge", + "merge_method", + "min_entries_to_merge", + "min_entries_to_merge_wait_minutes" + ] + } + } + }, + { + "title": "required_deployments", + "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_deployments" + ] + }, + "parameters": { + "type": "object", + "properties": { + "required_deployment_environments": { + "type": "array", + "description": "The environments that must be successfully deployed to before branches can be merged.", + "items": { + "type": "string" + } + } + }, + "required": [ + "required_deployment_environments" + ] + } + } + }, + { + "title": "required_signatures", + "description": "Commits pushed to matching refs must have verified signatures.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_signatures" + ] + } + } + }, + { + "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.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "pull_request" + ] + }, + "parameters": { + "type": "object", + "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", + "items": { + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "automatic_copilot_code_review_enabled": { + "type": "boolean", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean", + "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." + }, + "require_code_owner_review": { + "type": "boolean", + "description": "Require an approving review in pull requests that modify files that have a designated code owner." + }, + "require_last_push_approval": { + "type": "boolean", + "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." + }, + "required_approving_review_count": { + "type": "integer", + "description": "The number of approving reviews that are required before a pull request can be merged.", + "minimum": 0, + "maximum": 10 + }, + "required_review_thread_resolution": { + "type": "boolean", + "description": "All conversations on code must be resolved before a pull request can be merged." + } + }, + "required": [ + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "require_last_push_approval", + "required_approving_review_count", + "required_review_thread_resolution" + ] + } + } + }, + { + "title": "required_status_checks", + "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_status_checks" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "required_status_checks": { + "type": "array", + "description": "Status checks that are required.", + "items": { + "title": "StatusCheckConfiguration", + "description": "Required status check", + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "The status check context name that must be present on the commit." + }, + "integration_id": { + "type": "integer", + "description": "The optional integration ID that this status check must originate from." + } + }, + "required": [ + "context" + ] + } + }, + "strict_required_status_checks_policy": { + "type": "boolean", + "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." + } + }, + "required": [ + "required_status_checks", + "strict_required_status_checks_policy" + ] + } + } + }, + { + "title": "non_fast_forward", + "description": "Prevent users with push access from force pushing to refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "non_fast_forward" + ] + } + } + }, + { + "title": "commit_message_pattern", + "description": "Parameters to be used for the commit_message_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_message_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "commit_author_email_pattern", + "description": "Parameters to be used for the commit_author_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_author_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "committer_email_pattern", + "description": "Parameters to be used for the committer_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "committer_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "branch_name_pattern", + "description": "Parameters to be used for the branch_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "branch_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "tag_name_pattern", + "description": "Parameters to be used for the tag_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tag_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } + }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + } + ] + } + }, + "created_at": { "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "created_at", - "updated_at", - "members_count", - "repos_count", - "organization" - ] + } }, "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, - "members_count": 3, - "repos_count": 10, - "created_at": "2017-07-14T16:53:42Z", - "updated_at": "2017-08-17T12:37:15Z", - "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", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "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", - "updated_at": "2017-08-17T12:37:15Z", - "type": "Organization" - } + "id": 21, + "name": "super cool ruleset", + "target": "branch", + "source_type": "Organization", + "source": "my-org", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] + }, + "repository_name": { + "include": [ + "important_repository", + "another_important_repository" + ], + "exclude": [ + "unimportant_repository" + ], + "protected": true + } + }, + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" + } + } + ], + "node_id": "RRS_lACkVXNlcgQB", + "_links": { + "self": { + "href": "https://api.github.com/orgs/my-org/rulesets/21" + }, + "html": { + "href": "https://github.com/organizations/my-org/settings/rules/21" + } + }, + "created_at": "2023-08-15T08:43:03Z", + "updated_at": "2023-09-23T16:29:47Z" } } } } } }, - "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" @@ -165352,64 +160166,19 @@ "documentation_url": { "type": "string" }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } }, - "403": { - "description": "Forbidden", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -165434,26 +160203,115 @@ } } } + } + }, + "delete": { + "summary": "Delete an organization repository ruleset", + "description": "Delete a ruleset for an organization.", + "tags": [ + "repos" + ], + "operationId": "repos/delete-org-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/rules#delete-an-organization-repository-ruleset" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams" + "category": "orgs", + "subcategory": "rules" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ruleset_id", + "description": "The ID of the ruleset.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "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" + } + } + } + } + } + }, + "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" + } + } + } + } + } + } } } }, - "/orgs/{org}/teams/{team_slug}": { + "/orgs/{org}/rulesets/{ruleset_id}/history": { "get": { - "summary": "Get a team by name", - "description": "Gets a team using the team's `slug`. To create the `slug`, GitHub replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `\"My TEam Näme\"` would become `my-team-name`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`.", + "summary": "Get organization ruleset history", + "description": "Get the history of an organization ruleset.", "tags": [ - "teams" + "orgs" ], - "operationId": "teams/get-by-name", + "operationId": "orgs/get-org-ruleset-history", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#get-a-team-by-name" + "url": "https://docs.github.com/rest/orgs/rules#get-organization-ruleset-history" }, "parameters": [ { @@ -165466,12 +160324,30 @@ } }, { - "name": "team_slug", - "description": "The slug of the team name.", + "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": "ruleset_id", + "description": "The ID of the ruleset.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], @@ -165481,709 +160357,318 @@ "content": { "application/json": { "schema": { - "title": "Full Team", - "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "array", + "items": { + "title": "Ruleset version", + "type": "object", + "description": "The historical version of a ruleset", + "required": [ + "version_id", + "actor", + "updated_at" + ], + "properties": { + "version_id": { + "type": "integer", + "description": "The ID of the previous version of the ruleset" + }, + "actor": { + "type": "object", + "description": "The actor who updated the ruleset", + "properties": { + "id": { + "type": "integer" + }, + "type": { + "type": "string" + } + } + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + } + }, + "examples": { + "default": { + "value": [ + { + "version_id": 3, + "actor": { + "id": 1, + "type": "User" + }, + "updated_at": "2024-010-23T16:29:47Z" + }, + { + "version_id": 2, + "actor": { + "id": 2, + "type": "User" + }, + "updated_at": "2024-09-23T16:29:47Z" + }, + { + "version_id": 1, + "actor": { + "id": 1, + "type": "User" + }, + "updated_at": "2024-08-23T16:29:47Z" + } + ] + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 42 - ] + "message": { + "type": "string" }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] + "documentation_url": { + "type": "string" }, "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Developers" - ] + "type": "string" }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] + "status": { + "type": "string" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] + "documentation_url": { + "type": "string" }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ], - "examples": [ - "closed" - ] + "url": { + "type": "string" }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "enum": [ - "notifications_enabled", - "notifications_disabled" + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "rules" + } + } + }, + "/orgs/{org}/rulesets/{ruleset_id}/history/{version_id}": { + "get": { + "summary": "Get organization ruleset version", + "description": "Get a version of an organization ruleset.", + "tags": [ + "orgs" + ], + "operationId": "orgs/get-org-ruleset-version", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/rules#get-organization-ruleset-version" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ruleset_id", + "description": "The ID of the ruleset.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "version_id", + "description": "The ID of the version", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "title": "Ruleset version", + "type": "object", + "description": "The historical version of a ruleset", + "required": [ + "version_id", + "actor", + "updated_at" ], - "examples": [ - "notifications_enabled" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "push" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "parent": { - "anyOf": [ - { - "type": "null" + "properties": { + "version_id": { + "type": "integer", + "description": "The ID of the previous version of the ruleset" }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", + "actor": { "type": "object", + "description": "The actor who updated the ruleset", "properties": { "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] + "type": "integer" }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" + "type": { + "type": "string" + } + } + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + { + "type": "object", + "required": [ + "state" + ], + "properties": { + "state": { + "type": "object", + "description": "The state of the ruleset version" + } + } + } + ] + }, + "examples": { + "default": { + "value": [ + { + "version_id": 3, + "actor": { + "id": 1, + "type": "User" + }, + "updated_at": "2024-010-23T16:29:47Z", + "state": { + "id": 21, + "name": "super cool ruleset", + "target": "branch", + "source_type": "Organization", + "source": "my-org", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" + "exclude": [ + "refs/heads/dev*" ] }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] + "repository_name": { + "include": [ + "important_repository", + "another_important_repository" + ], + "exclude": [ + "unimportant_repository" + ], + "protected": true } }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" + } + } ] } - ] - }, - "members_count": { - "type": "integer", - "examples": [ - 3 - ] - }, - "repos_count": { - "type": "integer", - "examples": [ - 10 - ] + } + ] + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-14T16:53:42Z" - ] + "documentation_url": { + "type": "string" }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-08-17T12:37:15Z" - ] + "url": { + "type": "string" }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - }, - "name": { - "type": "string", - "examples": [ - "github" - ] - }, - "company": { - "type": "string", - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": "string", - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": "string", - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "github" - ] - }, - "is_verified": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_organization_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_repository_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "private_gists": { - "type": [ - "integer", - "null" - ], - "examples": [ - 81 - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ], - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ], - "examples": [ - 8 - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } - }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": [ - "string", - "null" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "members_allowed_repository_creation_type": { - "type": "string", - "examples": [ - "all" - ] - }, - "members_can_create_public_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_public_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "created_at", - "updated_at", - "members_count", - "repos_count", - "organization" - ] - }, - "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, - "members_count": 3, - "repos_count": 10, - "created_at": "2017-07-14T16:53:42Z", - "updated_at": "2017-08-17T12:37:15Z", - "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", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "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", - "updated_at": "2017-08-17T12:37:15Z", - "type": "Organization" - } + "status": { + "type": "string" } } } } } }, - "404": { - "description": "Resource not found", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -166212,20 +160697,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams" + "category": "orgs", + "subcategory": "rules" } - }, - "patch": { - "summary": "Update a team", - "description": "To edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`.", + } + }, + "/orgs/{org}/secret-scanning/alerts": { + "get": { + "summary": "List secret scanning alerts for an organization", + "description": "Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.\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 `repo` or `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": [ - "teams" + "secret-scanning" ], - "operationId": "teams/update-in-org", + "operationId": "secret-scanning/list-alerts-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#update-a-team" + "url": "https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization" }, "parameters": [ { @@ -166238,1756 +160725,1150 @@ } }, { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, + "name": "state", + "in": "query", + "description": "Set to `open` or `resolved` to only list secret scanning alerts in a specific state.", + "required": false, + "schema": { + "type": "string", + "enum": [ + "open", + "resolved" + ] + } + }, + { + "name": "secret_type", + "in": "query", + "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", + "required": false, "schema": { "type": "string" } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the team." - }, - "description": { - "type": "string", - "description": "The description of the team." - }, - "privacy": { - "type": "string", - "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \n**For a parent or child team:** \n * `closed` - visible to all members of this organization.", - "enum": [ - "secret", - "closed" - ] - }, - "notification_setting": { - "type": "string", - "description": "The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: \n * `notifications_enabled` - team members receive notifications when the team is @mentioned. \n * `notifications_disabled` - no one receives notifications.", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ] - }, - "permission": { - "type": "string", - "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.", - "enum": [ - "pull", - "push", - "admin" - ], - "default": "pull" - }, - "parent_team_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of a team to set as the parent team." - } - } - }, - "examples": { - "default": { - "value": { - "name": "new team name", - "description": "new team description", - "privacy": "closed", - "notification_setting": "notifications_enabled" - } - } - } + }, + { + "name": "resolution", + "in": "query", + "description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.", + "required": false, + "schema": { + "type": "string" + } + }, + { + "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.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated" + ], + "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": "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": "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 receive an initial cursor on your first request, include an empty \"before\" query string.", + "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 events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "validity", + "in": "query", + "description": "A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`.", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "is_publicly_leaked", + "in": "query", + "description": "A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present.", + "required": false, + "schema": { + "type": "boolean", + "default": false + } + }, + { + "name": "is_multi_repo", + "in": "query", + "description": "A boolean value representing whether or not to filter alerts by the multi-repo tag being present.", + "required": false, + "schema": { + "type": "boolean", + "default": false + } + }, + { + "name": "hide_secret", + "in": "query", + "description": "A boolean value representing whether or not to hide literal secrets in the results.", + "required": false, + "schema": { + "type": "boolean", + "default": false } } - }, + ], "responses": { "200": { - "description": "Response when the updated information already exists", + "description": "Response", "content": { "application/json": { "schema": { - "title": "Full Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Developers" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ], - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ], - "examples": [ - "notifications_enabled" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "push" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] - } - ] - }, - "members_count": { - "type": "integer", - "examples": [ - 3 - ] - }, - "repos_count": { - "type": "integer", - "examples": [ - 10 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-14T16:53:42Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-08-17T12:37:15Z" - ] - }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - }, - "name": { - "type": "string", - "examples": [ - "github" - ] - }, - "company": { - "type": "string", - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": "string", - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": "string", - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "github" - ] - }, - "is_verified": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_organization_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_repository_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "private_gists": { - "type": [ - "integer", - "null" - ], - "examples": [ - 81 - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ], - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ], - "examples": [ - 8 - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } + "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": { + "anyOf": [ + { + "type": "null" }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": [ - "string", - "null" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "members_allowed_repository_creation_type": { - "type": "string", - "examples": [ - "all" - ] - }, - "members_can_create_public_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_public_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } + { + "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 + } + ] }, - "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" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "created_at", - "updated_at", - "members_count", - "repos_count", - "organization" - ] - }, - "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, - "members_count": 3, - "repos_count": 10, - "created_at": "2017-07-14T16:53:42Z", - "updated_at": "2017-08-17T12:37:15Z", - "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", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "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", - "updated_at": "2017-08-17T12:37:15Z", - "type": "Organization" - } - } - } - } - } - } - }, - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Full Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Developers" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ], - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ], - "examples": [ - "notifications_enabled" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "push" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] + "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 + }, + "locations_url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the code locations for this alert." + }, + "state": { + "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": { + "type": [ + "string", + "null" + ], + "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + null + ] + }, + "resolved_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "resolved_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "secret_type_display_name": { + "type": "string", + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + }, + "secret": { + "type": "string", + "description": "The secret that was detected." + }, + "repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "A unique identifier of the repository.", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository.", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "description": "The name of the repository.", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository.", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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" - ] - } - ] - }, - "members_count": { - "type": "integer", - "examples": [ - 3 - ] - }, - "repos_count": { - "type": "integer", - "examples": [ - 10 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-14T16:53:42Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-08-17T12:37:15Z" - ] - }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - }, - "name": { - "type": "string", - "examples": [ - "github" - ] - }, - "company": { - "type": "string", - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": "string", - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": "string", - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "github" - ] - }, - "is_verified": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_organization_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_repository_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "private_gists": { - "type": [ - "integer", - "null" - ], - "examples": [ - 81 - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ], - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ], - "examples": [ - 8 - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } + "private": { + "type": "boolean", + "description": "Whether the repository is private." }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": [ - "string", - "null" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "members_allowed_repository_creation_type": { - "type": "string", - "examples": [ - "all" - ] - }, - "members_can_create_public_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_public_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "created_at", - "updated_at", - "members_count", - "repos_count", - "organization" - ] - }, - "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, - "members_count": 3, - "repos_count": 10, - "created_at": "2017-07-14T16:53:42Z", - "updated_at": "2017-08-17T12:37:15Z", - "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", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "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", - "updated_at": "2017-08-17T12:37:15Z", - "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" - } - } - } - } - } - }, - "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" + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com.", + "examples": [ + "https://github.com/octocat/Hello-World" + ] }, - "field": { - "type": "string" + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description.", + "examples": [ + "This your first repo!" + ] }, - "message": { - "type": "string" + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." }, - "code": { - "type": "string" + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] }, - "index": { - "type": "integer" + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] }, - "value": { - "oneOf": [ - { + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks" + ] + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + }, + "push_protection_bypassed": { + "type": [ + "boolean", + "null" + ], + "description": "Whether push protection was bypassed for the detected secret." + }, + "push_protection_bypassed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { "type": [ "string", "null" ] }, - { + "email": { "type": [ - "integer", + "string", "null" ] }, - { + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { "type": [ - "array", + "string", "null" ], - "items": { - "type": "string" - } + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] } - } - } - } - } - } - } - } - }, - "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": "teams", - "subcategory": "teams" - } - }, - "delete": { - "summary": "Delete a team", - "description": "To delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`.", - "tags": [ - "teams" - ], - "operationId": "teams/delete-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#delete-a-team" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams" - } - } - }, - "/orgs/{org}/teams/{team_slug}/discussions": { - "get": { - "summary": "List discussions", - "description": "List all discussions on a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", - "tags": [ - "teams" - ], - "operationId": "teams/list-discussions-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/discussions#list-discussions" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "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/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": "pinned", - "in": "query", - "required": false, - "description": "Pinned discussions only filter", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", - "type": "object", - "properties": { - "author": { + ] + }, + "push_protection_bypassed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "push_protection_bypass_request_reviewer": { "anyOf": [ { "type": "null" @@ -168162,195 +162043,530 @@ } ] }, - "body": { - "description": "The main text of the discussion.", - "type": "string", - "examples": [ - "Please suggest improvements to our workflow in comments." - ] - }, - "body_html": { - "type": "string", - "examples": [ - "

Hi! This is an area for us to collaborate as a team

" - ] - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "type": "string", - "examples": [ - "0307116bbf7ced493b8d8a346c650b71" - ] - }, - "comments_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "comments_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." }, - "last_edited_at": { + "push_protection_bypass_request_comment": { "type": [ "string", "null" ], - "format": "date-time" + "description": "An optional comment when requesting a push protection bypass." }, - "html_url": { - "type": "string", + "push_protection_bypass_request_html_url": { + "type": [ + "string", + "null" + ], "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", - "examples": [ - 42 - ] - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", - "examples": [ - true - ] + "description": "The URL to a push protection bypass request." }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", - "examples": [ - true - ] + "resolution_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment that was optionally added when this alert was closed" }, - "team_url": { + "validity": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027" + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" ] }, - "title": { - "description": "The title of the discussion.", - "type": "string", - "examples": [ - "How can we improve our workflow?" - ] + "publicly_leaked": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the secret was publicly leaked." }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] + "multi_repo": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was found in multiple repositories in the same organization or enterprise." }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" - ] + "is_base64_encoded": { + "type": [ + "boolean", + "null" + ], + "description": "A boolean value representing whether or not alert is base64 encoded" }, - "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" + "first_location_detected": { + "anyOf": [ + { + "type": "null" }, - "rocket": { - "type": "integer" + { + "description": "Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request.\n", + "oneOf": [ + { + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path in the repository", + "examples": [ + "/example/secrets.txt" + ] + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "examples": [ + "af5626b4a114abcb82d63db7c8082c3c4756e51b" + ] + }, + "blob_url": { + "type": "string", + "description": "The API URL to get the associated blob resource" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "examples": [ + "af5626b4a114abcb82d63db7c8082c3c4756e51b" + ] + }, + "commit_url": { + "type": "string", + "description": "The API URL to get the associated commit resource" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + { + "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.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "examples": [ + "/example/Home.md" + ] + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "examples": [ + "af5626b4a114abcb82d63db7c8082c3c4756e51b" + ] + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "examples": [ + "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + ] + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "examples": [ + "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + ] + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "examples": [ + "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + ] + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/1347" + ] + } + }, + "required": [ + "issue_title_url" + ] + }, + { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/1347" + ] + } + }, + "required": [ + "issue_body_url" + ] + }, + { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + ] + } + }, + "required": [ + "issue_comment_url" + ] + }, + { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", + "type": "object", + "properties": { + "discussion_title_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "examples": [ + "https://github.com/community/community/discussions/39082" + ] + } + }, + "required": [ + "discussion_title_url" + ] + }, + { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", + "type": "object", + "properties": { + "discussion_body_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "examples": [ + "https://github.com/community/community/discussions/39082#discussion-4566270" + ] + } + }, + "required": [ + "discussion_body_url" + ] + }, + { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", + "type": "object", + "properties": { + "discussion_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "examples": [ + "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + ] + } + }, + "required": [ + "discussion_comment_url" + ] + }, + { + "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.", + "type": "object", + "properties": { + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + ] + } + }, + "required": [ + "pull_request_title_url" + ] + }, + { + "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.", + "type": "object", + "properties": { + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + ] + } + }, + "required": [ + "pull_request_body_url" + ] + }, + { + "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.", + "type": "object", + "properties": { + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + ] + } + }, + "required": [ + "pull_request_comment_url" + ] + }, + { + "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.", + "type": "object", + "properties": { + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + ] + } + }, + "required": [ + "pull_request_review_url" + ] + }, + { + "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.", + "type": "object", + "properties": { + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + ] + } + }, + "required": [ + "pull_request_review_comment_url" + ] + } + ] } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" ] + }, + "has_more_locations": { + "type": "boolean", + "description": "A boolean value representing whether or not the token in the alert was detected in more than one location." } - }, - "required": [ - "author", - "body", - "body_html", - "body_version", - "comments_count", - "comments_url", - "created_at", - "last_edited_at", - "html_url", - "pinned", - "private", - "node_id", - "number", - "team_url", - "title", - "updated_at", - "url" - ] + } } }, "examples": { "default": { "value": [ { - "author": { + "number": 2, + "created_at": "2020-11-06T18:48:51Z", + "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2", + "html_url": "https://github.com/owner/private-repo/security/secret-scanning/2", + "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations", + "state": "resolved", + "resolution": "false_positive", + "resolved_at": "2020-11-07T02:47:13Z", + "resolved_by": { + "login": "monalisa", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://alambic.github.com/avatars/u/2?", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "site_admin": true + }, + "secret_type": "adafruit_io_key", + "secret_type_display_name": "Adafruit IO Key", + "secret": "aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX", + "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" + }, + "push_protection_bypassed_by": { + "login": "monalisa", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://alambic.github.com/avatars/u/2?", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "site_admin": true + }, + "push_protection_bypassed": true, + "push_protection_bypassed_at": "2020-11-06T21:48:51Z", + "push_protection_bypass_request_reviewer": { "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "id": 3, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://alambic.github.com/avatars/u/3?", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", @@ -168364,542 +162580,181 @@ "events_url": "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": true }, - "body": "Hi! This is an area for us to collaborate as a team.", - "body_html": "

Hi! This is an area for us to collaborate as a team

", - "body_version": "0d495416a700fb06133c612575d92bfb", - "comments_count": 0, - "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", - "created_at": "2018-01-25T18:56:31Z", - "last_edited_at": null, - "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", - "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", + "push_protection_bypass_request_reviewer_comment": "Example response", + "push_protection_bypass_request_comment": "Example comment", + "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", + "resolution_comment": "Example comment", + "validity": "active", + "publicly_leaked": false, + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "path": "/example/secrets.txt", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + }, + "has_more_locations": true + }, + { "number": 1, - "pinned": false, - "private": false, - "team_url": "https://api.github.com/teams/2343027", - "title": "Our first team post", - "updated_at": "2018-01-25T18:56:31Z", - "url": "https://api.github.com/teams/2343027/discussions/1", - "reactions": { - "url": "https://api.github.com/teams/2343027/discussions/1/reactions", - "total_count": 5, - "+1": 3, - "-1": 1, - "laugh": 0, - "confused": 0, - "heart": 1, - "hooray": 0, - "eyes": 1, - "rocket": 1 - } - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "discussions" - } - }, - "post": { - "summary": "Create a discussion", - "description": "Creates a new discussion post on a team's page.\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)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "teams" - ], - "operationId": "teams/create-discussion-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/discussions#create-a-discussion" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "The discussion post's title." - }, - "body": { - "type": "string", - "description": "The discussion post's body text." - }, - "private": { - "type": "boolean", - "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.", - "default": false - } - }, - "required": [ - "title", - "body" - ] - }, - "examples": { - "default": { - "value": { - "title": "Our first team post", - "body": "Hi! This is an area for us to collaborate as a team." + "created_at": "2020-11-06T18:18:30Z", + "url": "https://api.github.com/repos/owner/repo/secret-scanning/alerts/1", + "html_url": "https://github.com/owner/repo/security/secret-scanning/1", + "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/1/locations", + "state": "open", + "resolution": null, + "resolved_at": null, + "resolved_by": null, + "secret_type": "mailchimp_api_key", + "secret_type_display_name": "Mailchimp API Key", + "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", + "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" + }, + "push_protection_bypassed_by": null, + "push_protection_bypassed": false, + "push_protection_bypassed_at": null, + "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, + "push_protection_bypass_request_comment": null, + "push_protection_bypass_request_html_url": null, + "resolution_comment": null, + "validity": "unknown", + "publicly_leaked": false, + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "issue_title_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + }, + "has_more_locations": false + } + ] } } } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } } - } - }, - "responses": { - "201": { - "description": "Response", + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "author": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "body": { - "description": "The main text of the discussion.", - "type": "string", - "examples": [ - "Please suggest improvements to our workflow in comments." - ] - }, - "body_html": { - "type": "string", - "examples": [ - "

Hi! This is an area for us to collaborate as a team

" - ] - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "type": "string", - "examples": [ - "0307116bbf7ced493b8d8a346c650b71" - ] - }, - "comments_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "comments_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", - "examples": [ - 42 - ] - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", - "examples": [ - true - ] - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", - "examples": [ - true - ] - }, - "team_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027" - ] - }, - "title": { - "description": "The title of the discussion.", - "type": "string", - "examples": [ - "How can we improve our workflow?" - ] + "message": { + "type": "string" }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] + "documentation_url": { + "type": "string" }, "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" - ] + "type": "string" }, - "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" - ] + "status": { + "type": "string" } - }, - "required": [ - "author", - "body", - "body_html", - "body_version", - "comments_count", - "comments_url", - "created_at", - "last_edited_at", - "html_url", - "pinned", - "private", - "node_id", - "number", - "team_url", - "title", - "updated_at", - "url" - ] - }, - "examples": { - "default": { - "value": { - "author": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "body": "Hi! This is an area for us to collaborate as a team.", - "body_html": "

Hi! This is an area for us to collaborate as a team

", - "body_version": "0d495416a700fb06133c612575d92bfb", - "comments_count": 0, - "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", - "created_at": "2018-01-25T18:56:31Z", - "last_edited_at": null, - "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", - "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", - "number": 1, - "pinned": false, - "private": false, - "team_url": "https://api.github.com/teams/2343027", - "title": "Our first team post", - "updated_at": "2018-01-25T18:56:31Z", - "url": "https://api.github.com/teams/2343027/discussions/1", - "reactions": { - "url": "https://api.github.com/teams/2343027/discussions/1/reactions", - "total_count": 5, - "+1": 3, - "-1": 1, - "laugh": 0, - "confused": 0, - "heart": 1, - "hooray": 0, - "eyes": 1, - "rocket": 1 - } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" } } } @@ -168908,25 +162763,30 @@ } }, "x-github": { - "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "discussions" + "category": "secret-scanning", + "subcategory": "secret-scanning" } } }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": { + "/orgs/{org}/secret-scanning/pattern-configurations": { "get": { - "summary": "Get a discussion", - "description": "Get a specific discussion on a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "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": [ - "teams" + "secret-scanning" ], - "operationId": "teams/get-discussion-in-org", + "operationId": "secret-scanning/list-org-pattern-configs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/discussions#get-a-discussion" + "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": [ { @@ -168937,24 +162797,6 @@ "schema": { "type": "string" } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { @@ -168963,439 +162805,285 @@ "content": { "application/json": { "schema": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", + "title": "Secret scanning pattern configuration", + "description": "A collection of secret scanning patterns and their settings related to push protection.", "type": "object", "properties": { - "author": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "body": { - "description": "The main text of the discussion.", - "type": "string", - "examples": [ - "Please suggest improvements to our workflow in comments." - ] - }, - "body_html": { - "type": "string", - "examples": [ - "

Hi! This is an area for us to collaborate as a team

" - ] - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "type": "string", - "examples": [ - "0307116bbf7ced493b8d8a346c650b71" - ] - }, - "comments_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "comments_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "last_edited_at": { + "pattern_config_version": { "type": [ "string", "null" ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - ] + "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." }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", - "examples": [ - 42 - ] + "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", + "null" + ], + "description": "The version of this pattern if it's a custom pattern." + }, + "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", + "null" + ], + "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", + null + ] + }, + "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" + ] + } + } + } }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", - "examples": [ - true + "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", + "null" + ], + "description": "The version of this pattern if it's a custom pattern." + }, + "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", + "null" + ], + "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", + null + ] + }, + "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" }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", - "examples": [ - true - ] + "documentation_url": { + "type": "string" }, - "team_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027" - ] + "url": { + "type": "string" }, - "title": { - "description": "The title of the discussion.", - "type": "string", - "examples": [ - "How can we improve our workflow?" - ] + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] + "documentation_url": { + "type": "string" }, "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" - ] + "type": "string" }, - "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": [ - "author", - "body", - "body_html", - "body_version", - "comments_count", - "comments_url", - "created_at", - "last_edited_at", - "html_url", - "pinned", - "private", - "node_id", - "number", - "team_url", - "title", - "updated_at", - "url" - ] - }, - "examples": { - "default": { - "value": { - "author": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "body": "Hi! This is an area for us to collaborate as a team.", - "body_html": "

Hi! This is an area for us to collaborate as a team

", - "body_version": "0d495416a700fb06133c612575d92bfb", - "comments_count": 0, - "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", - "created_at": "2018-01-25T18:56:31Z", - "last_edited_at": null, - "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", - "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", - "number": 1, - "pinned": false, - "private": false, - "team_url": "https://api.github.com/teams/2343027", - "title": "Our first team post", - "updated_at": "2018-01-25T18:56:31Z", - "url": "https://api.github.com/teams/2343027/discussions/1", - "reactions": { - "url": "https://api.github.com/teams/2343027/discussions/1/reactions", - "total_count": 5, - "+1": 3, - "-1": 1, - "laugh": 0, - "confused": 0, - "heart": 1, - "hooray": 0, - "eyes": 1, - "rocket": 1 - } + "status": { + "type": "string" } } } } } } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "discussions" } }, "patch": { - "summary": "Update a discussion", - "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "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": [ - "teams" + "secret-scanning" ], - "operationId": "teams/update-discussion-in-org", + "operationId": "secret-scanning/update-org-pattern-configs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/discussions#update-a-discussion" + "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": [ { @@ -169406,47 +163094,91 @@ "schema": { "type": "string" } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { - "title": { - "type": "string", - "description": "The discussion post's title." + "pattern_config_version": { + "type": [ + "string", + "null" + ], + "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." }, - "body": { - "type": "string", - "description": "The discussion post's body text." + "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", + "null" + ], + "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." + }, + "push_protection_setting": { + "type": "string", + "description": "Push protection setting to set for the pattern.", + "enum": [ + "disabled", + "enabled" + ] + } + } + } } } }, "examples": { "default": { "value": { - "title": "Welcome to our first team post" + "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" + } + ] } } } @@ -169459,414 +163191,238 @@ "content": { "application/json": { "schema": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", "type": "object", "properties": { - "author": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "body": { - "description": "The main text of the discussion.", + "pattern_config_version": { "type": "string", - "examples": [ - "Please suggest improvements to our workflow in comments." - ] + "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" }, - "body_html": { - "type": "string", - "examples": [ - "

Hi! This is an area for us to collaborate as a team

" - ] + "documentation_url": { + "type": "string" }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "type": "string", - "examples": [ - "0307116bbf7ced493b8d8a346c650b71" - ] + "url": { + "type": "string" }, - "comments_count": { - "type": "integer", - "examples": [ - 0 + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" ] }, - "comments_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + "documentation_url": { + "type": [ + "string", + "null" ] }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" + "detail": { + "type": [ + "string", + "null" ] }, - "last_edited_at": { + "status": { + "type": "integer" + }, + "scimType": { "type": [ "string", "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" ] }, - "node_id": { - "type": "string", - "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - ] + "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" }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", - "examples": [ - 42 - ] + "documentation_url": { + "type": "string" }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", - "examples": [ - true - ] + "url": { + "type": "string" }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", - "examples": [ - true - ] + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "team_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027" - ] + "documentation_url": { + "type": "string" }, - "title": { - "description": "The title of the discussion.", - "type": "string", - "examples": [ - "How can we improve our workflow?" - ] + "url": { + "type": "string" }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] + "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", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" - ] + "type": "string" }, - "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" - ] + "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": [ - "author", - "body", - "body_html", - "body_version", - "comments_count", - "comments_url", - "created_at", - "last_edited_at", - "html_url", - "pinned", - "private", - "node_id", - "number", - "team_url", - "title", - "updated_at", - "url" - ] - }, - "examples": { - "default": { - "value": { - "author": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "body": "Hi! This is an area for us to collaborate as a team.", - "body_html": "

Hi! This is an area for us to collaborate as a team

", - "body_version": "0d495416a700fb06133c612575d92bfb", - "comments_count": 1, - "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", - "created_at": "2018-01-25T18:56:31Z", - "last_edited_at": "2018-01-26T18:22:20Z", - "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", - "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", - "number": 1, - "pinned": false, - "private": false, - "team_url": "https://api.github.com/teams/2343027", - "title": "Welcome to our first team post", - "updated_at": "2018-01-26T18:22:20Z", - "url": "https://api.github.com/teams/2343027/discussions/1", - "reactions": { - "url": "https://api.github.com/teams/2343027/discussions/1/reactions", - "total_count": 5, - "+1": 3, - "-1": 1, - "laugh": 0, - "confused": 0, - "heart": 1, - "hooray": 0, - "eyes": 1, - "rocket": 1 + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } } } } @@ -169874,24 +163430,20 @@ } } } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "discussions" } - }, - "delete": { - "summary": "Delete a discussion", - "description": "Delete a discussion from a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + } + }, + "/orgs/{org}/security-advisories": { + "get": { + "summary": "List repository security advisories for an organization", + "description": "Lists repository security advisories 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 `repo` or `repository_advisories:write` scope to use this endpoint.", "tags": [ - "teams" + "security-advisories" ], - "operationId": "teams/delete-discussion-in-org", + "operationId": "security-advisories/list-org-repository-advisories", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/discussions#delete-a-discussion" + "url": "https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization" }, "parameters": [ { @@ -169904,107 +163456,77 @@ } }, { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, + "name": "direction", + "description": "The direction to sort the results by.", + "in": "query", + "required": false, "schema": { - "type": "string" + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" } }, { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "discussions" - } - } - }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": { - "get": { - "summary": "List discussion comments", - "description": "List all comments on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", - "tags": [ - "teams" - ], - "operationId": "teams/list-discussion-comments-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, + "name": "sort", + "description": "The property to sort the results by.", + "in": "query", + "required": false, "schema": { - "type": "string" + "type": "string", + "enum": [ + "created", + "updated", + "published" + ], + "default": "created" } }, { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, + "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": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "direction", - "description": "The direction to sort the results by.", + "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", - "enum": [ - "asc", - "desc" - ], - "default": "desc" + "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).\"", + "description": "The number of advisories to return per page. For more information, 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": 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": "state", + "description": "Filter by the state of the repository advisories. Only advisories of this state will be returned.", "in": "query", + "required": false, "schema": { - "type": "integer", - "default": 1 + "type": "string", + "enum": [ + "triage", + "draft", + "published", + "closed" + ] } } ], @@ -170016,15 +163538,64 @@ "schema": { "type": "array", "items": { - "title": "Team Discussion Comment", - "description": "A reply to a discussion within a team.", + "description": "A repository security advisory.", "type": "object", "properties": { + "ghsa_id": { + "type": "string", + "description": "The GitHub Security Advisory ID.", + "readOnly": true + }, + "cve_id": { + "type": [ + "string", + "null" + ], + "description": "The Common Vulnerabilities and Exposures (CVE) ID." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The API URL for the advisory.", + "readOnly": true + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL for the advisory.", + "readOnly": true + }, + "summary": { + "type": "string", + "description": "A short summary of the advisory.", + "maxLength": 1024 + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A detailed description of what the advisory entails.", + "maxLength": 65535 + }, + "severity": { + "type": [ + "string", + "null" + ], + "description": "The severity of the advisory.", + "enum": [ + "critical", + "high", + "medium", + "low", + null + ] + }, "author": { - "anyOf": [ - { - "type": "null" - }, + "readOnly": true, + "description": "The author of the advisory.", + "allOf": [ { "title": "Simple User", "description": "A GitHub user.", @@ -170193,738 +163764,748 @@ "url" ] } - ] - }, - "body": { - "description": "The main text of the comment.", - "type": "string", - "examples": [ - "I agree with this suggestion." - ] - }, - "body_html": { - "type": "string", - "examples": [ - "

Do you like apples?

" - ] - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "type": "string", - "examples": [ - "0307116bbf7ced493b8d8a346c650b71" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-15T23:53:58Z" - ] - }, - "last_edited_at": { + ], "type": [ - "string", "null" - ], - "format": "date-time" - }, - "discussion_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" ] }, - "node_id": { - "type": "string", - "examples": [ - "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + "publisher": { + "readOnly": true, + "description": "The publisher of the advisory.", + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ], + "type": [ + "null" ] }, - "number": { - "description": "The unique sequence number of a team discussion comment.", - "type": "integer", - "examples": [ - 42 + "identifiers": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of identifier.", + "enum": [ + "CVE", + "GHSA" + ] + }, + "value": { + "type": "string", + "description": "The identifier value." + } + }, + "required": [ + "type", + "value" + ] + }, + "readOnly": true + }, + "state": { + "type": "string", + "description": "The state of the advisory.", + "enum": [ + "published", + "closed", + "withdrawn", + "draft", + "triage" ] }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The date and time of when the advisory was created, in ISO 8601 format.", + "readOnly": true + }, "updated_at": { - "type": "string", + "type": [ + "string", + "null" + ], "format": "date-time", - "examples": [ - "2018-01-15T23:53:58Z" - ] + "description": "The date and time of when the advisory was last updated, in ISO 8601 format.", + "readOnly": true }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" - ] + "published_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The date and time of when the advisory was published, in ISO 8601 format.", + "readOnly": true }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The date and time of when the advisory was closed, in ISO 8601 format.", + "readOnly": true + }, + "withdrawn_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.", + "readOnly": true + }, + "submission": { + "type": [ + "object", + "null" + ], + "readOnly": true, "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" + "accepted": { + "type": "boolean", + "description": "Whether a private vulnerability report was accepted by the repository's administrators.", + "readOnly": true } }, "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "accepted" ] - } - }, - "required": [ - "author", - "body", - "body_html", - "body_version", - "created_at", - "last_edited_at", - "discussion_url", - "html_url", - "node_id", - "number", - "updated_at", - "url" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "author": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "body": "Do you like apples?", - "body_html": "

Do you like apples?

", - "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51", - "created_at": "2018-01-15T23:53:58Z", - "last_edited_at": null, - "discussion_url": "https://api.github.com/teams/2403582/discussions/1", - "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", - "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", - "number": 1, - "updated_at": "2018-01-15T23:53:58Z", - "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", - "reactions": { - "url": "https://api.github.com/teams/2403582/discussions/1/reactions", - "total_count": 5, - "+1": 3, - "-1": 1, - "laugh": 0, - "confused": 0, - "heart": 1, - "hooray": 0, - "eyes": 1, - "rocket": 1 - } - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "discussion-comments" - } - }, - "post": { - "summary": "Create a discussion comment", - "description": "Creates a new comment on a team discussion.\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)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "teams" - ], - "operationId": "teams/create-discussion-comment-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "body": { - "type": "string", - "description": "The discussion comment's body text." - } - }, - "required": [ - "body" - ] - }, - "examples": { - "default": { - "value": { - "body": "Do you like apples?" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Team Discussion Comment", - "description": "A reply to a discussion within a team.", - "type": "object", - "properties": { - "author": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", + }, + "vulnerabilities": { + "type": [ + "array", + "null" + ], + "items": { + "description": "A product affected by the vulnerability detailed in a repository security advisory.", "type": "object", "properties": { - "name": { + "package": { + "description": "The name of the package affected by the vulnerability.", "type": [ - "string", + "object", "null" + ], + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "enum": [ + "rubygems", + "npm", + "pip", + "maven", + "nuget", + "composer", + "go", + "rust", + "erlang", + "actions", + "pub", + "other", + "swift" + ] + }, + "name": { + "type": [ + "string", + "null" + ], + "description": "The unique package name within its ecosystem." + } + }, + "required": [ + "ecosystem", + "name" ] }, - "email": { + "vulnerable_version_range": { "type": [ "string", "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] + ], + "description": "The range of the package versions affected by the vulnerability." }, - "gravatar_id": { + "patched_versions": { "type": [ "string", "null" ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] + "description": "The package version(s) that resolve the vulnerability." }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] + "vulnerable_functions": { + "type": [ + "array", + "null" + ], + "description": "The functions in the package that are affected.", + "items": { + "type": "string" + } + } + }, + "required": [ + "package", + "vulnerable_version_range", + "patched_versions", + "vulnerable_functions" + ], + "additionalProperties": false + } + }, + "cvss": { + "type": [ + "object", + "null" + ], + "properties": { + "vector_string": { + "type": [ + "string", + "null" + ], + "description": "The CVSS vector." + }, + "score": { + "type": [ + "number", + "null" + ], + "description": "The CVSS score.", + "minimum": 0, + "maximum": 10, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + }, + "cvss_severities": { + "type": [ + "object", + "null" + ], + "properties": { + "cvss_v3": { + "type": [ + "object", + "null" + ], + "properties": { + "vector_string": { + "type": [ + "string", + "null" + ], + "description": "The CVSS 3 vector string." + }, + "score": { + "type": [ + "number", + "null" + ], + "description": "The CVSS 3 score.", + "minimum": 0, + "maximum": 10, + "readOnly": true + } }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] + "required": [ + "vector_string", + "score" + ] + }, + "cvss_v4": { + "type": [ + "object", + "null" + ], + "properties": { + "vector_string": { + "type": [ + "string", + "null" + ], + "description": "The CVSS 4 vector string." + }, + "score": { + "type": [ + "number", + "null" + ], + "description": "The CVSS 4 score.", + "minimum": 0, + "maximum": 10, + "readOnly": true + } }, - "subscriptions_url": { + "required": [ + "vector_string", + "score" + ] + } + } + }, + "cwes": { + "type": [ + "array", + "null" + ], + "items": { + "type": "object", + "properties": { + "cwe_id": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "description": "The Common Weakness Enumeration (CWE) identifier." }, - "organizations_url": { + "name": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { + "description": "The name of the CWE.", + "readOnly": true + } + }, + "required": [ + "cwe_id", + "name" + ] + }, + "readOnly": true + }, + "cwe_ids": { + "type": [ + "array", + "null" + ], + "description": "A list of only the CWE IDs.", + "items": { + "type": "string" + } + }, + "credits": { + "type": [ + "array", + "null" + ], + "items": { + "type": "object", + "properties": { + "login": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] + "description": "The username of the user credited." }, - "events_url": { + "type": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "description": "The type of credit the user is receiving.", + "enum": [ + "analyst", + "finder", + "reporter", + "coordinator", + "remediation_developer", + "remediation_reviewer", + "remediation_verifier", + "tool", + "sponsor", + "other" ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" + } + } + } + }, + "credits_detailed": { + "type": [ + "array", + "null" + ], + "items": { + "description": "A credit given to a user for a repository security advisory.", + "type": "object", + "properties": { + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, "type": { "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" + "description": "The type of credit the user is receiving.", + "enum": [ + "analyst", + "finder", + "reporter", + "coordinator", + "remediation_developer", + "remediation_reviewer", + "remediation_verifier", + "tool", + "sponsor", + "other" ] }, - "user_view_type": { + "state": { "type": "string", - "examples": [ - "public" + "description": "The state of the user's acceptance of the credit.", + "enum": [ + "accepted", + "declined", + "pending" ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", + "user", "type", - "url" - ] - } - ] - }, - "body": { - "description": "The main text of the comment.", - "type": "string", - "examples": [ - "I agree with this suggestion." - ] - }, - "body_html": { - "type": "string", - "examples": [ - "

Do you like apples?

" - ] - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "type": "string", - "examples": [ - "0307116bbf7ced493b8d8a346c650b71" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-15T23:53:58Z" - ] - }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "discussion_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion comment.", - "type": "integer", - "examples": [ - 42 - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-15T23:53:58Z" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" - ] - }, - "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" + "state" + ], + "additionalProperties": false }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - } - }, - "required": [ - "author", - "body", - "body_html", - "body_version", - "created_at", - "last_edited_at", - "discussion_url", - "html_url", - "node_id", - "number", - "updated_at", - "url" - ] - }, - "examples": { - "default": { - "value": { - "author": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false + "readOnly": true }, - "body": "Do you like apples?", - "body_html": "

Do you like apples?

", - "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51", - "created_at": "2018-01-15T23:53:58Z", - "last_edited_at": null, - "discussion_url": "https://api.github.com/teams/2403582/discussions/1", - "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", - "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", - "number": 1, - "updated_at": "2018-01-15T23:53:58Z", - "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", - "reactions": { - "url": "https://api.github.com/teams/2403582/discussions/1/reactions", - "total_count": 5, - "+1": 3, - "-1": 1, - "laugh": 0, - "confused": 0, - "heart": 1, - "hooray": 0, - "eyes": 1, - "rocket": 1 - } - } - } - } - } - } - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "discussion-comments" - } - } - }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": { - "get": { - "summary": "Get a discussion comment", - "description": "Get a specific comment on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", - "tags": [ - "teams" - ], - "operationId": "teams/get-discussion-comment-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Team Discussion Comment", - "description": "A reply to a discussion within a team.", - "type": "object", - "properties": { - "author": { - "anyOf": [ - { - "type": "null" - }, - { + "collaborating_users": { + "type": [ + "array", + "null" + ], + "description": "A list of users that collaborate on the advisory.", + "items": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -171092,1057 +164673,828 @@ "url" ] } - ] - }, - "body": { - "description": "The main text of the comment.", - "type": "string", - "examples": [ - "I agree with this suggestion." - ] - }, - "body_html": { - "type": "string", - "examples": [ - "

Do you like apples?

" - ] - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "type": "string", - "examples": [ - "0307116bbf7ced493b8d8a346c650b71" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-15T23:53:58Z" - ] - }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "discussion_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion comment.", - "type": "integer", - "examples": [ - 42 - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-15T23:53:58Z" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" - ] - }, - "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": [ - "author", - "body", - "body_html", - "body_version", - "created_at", - "last_edited_at", - "discussion_url", - "html_url", - "node_id", - "number", - "updated_at", - "url" - ] - }, - "examples": { - "default": { - "value": { - "author": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false }, - "body": "Do you like apples?", - "body_html": "

Do you like apples?

", - "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51", - "created_at": "2018-01-15T23:53:58Z", - "last_edited_at": null, - "discussion_url": "https://api.github.com/teams/2403582/discussions/1", - "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", - "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", - "number": 1, - "updated_at": "2018-01-15T23:53:58Z", - "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", - "reactions": { - "url": "https://api.github.com/teams/2403582/discussions/1/reactions", - "total_count": 5, - "+1": 3, - "-1": 1, - "laugh": 0, - "confused": 0, - "heart": 1, - "hooray": 0, - "eyes": 1, - "rocket": 1 - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "discussion-comments" - } - }, - "patch": { - "summary": "Update a discussion comment", - "description": "Edits the body text of a discussion comment.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "teams" - ], - "operationId": "teams/update-discussion-comment-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "body": { - "type": "string", - "description": "The discussion comment's body text." - } - }, - "required": [ - "body" - ] - }, - "examples": { - "default": { - "value": { - "body": "Do you like pineapples?" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Team Discussion Comment", - "description": "A reply to a discussion within a team.", - "type": "object", - "properties": { - "author": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", + "collaborating_teams": { + "type": [ + "array", + "null" + ], + "description": "A list of teams that collaborate on the advisory.", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] + "type": "integer" }, "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "type": "string" }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] + "name": { + "type": "string" }, - "gravatar_id": { + "slug": { + "type": "string" + }, + "description": { "type": [ "string", "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" ] }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] + "privacy": { + "type": "string" }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "notification_setting": { + "type": "string" }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] + "permission": { + "type": "string" }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" + "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" ] }, - "events_url": { + "url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "format": "uri" }, - "received_events_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" + "https://github.com/orgs/rails/teams/core" ] }, - "site_admin": { - "type": "boolean" + "members_url": { + "type": "string" }, - "starred_at": { + "repositories_url": { "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "format": "uri" }, - "user_view_type": { - "type": "string", - "examples": [ - "public" + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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", + "parent" ] } - ] - }, - "body": { - "description": "The main text of the comment.", - "type": "string", - "examples": [ - "I agree with this suggestion." - ] - }, - "body_html": { - "type": "string", - "examples": [ - "

Do you like apples?

" - ] - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "type": "string", - "examples": [ - "0307116bbf7ced493b8d8a346c650b71" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-15T23:53:58Z" - ] - }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "discussion_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion comment.", - "type": "integer", - "examples": [ - 42 - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-15T23:53:58Z" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" - ] - }, - "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": [ - "author", - "body", - "body_html", - "body_version", - "created_at", - "last_edited_at", - "discussion_url", - "html_url", - "node_id", - "number", - "updated_at", - "url" - ] - }, - "examples": { - "default": { - "value": { - "author": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "body": "Do you like pineapples?", - "body_html": "

Do you like pineapples?

", - "body_version": "e6907b24d9c93cc0c5024a7af5888116", - "created_at": "2018-01-15T23:53:58Z", - "last_edited_at": "2018-01-26T18:22:20Z", - "discussion_url": "https://api.github.com/teams/2403582/discussions/1", - "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", - "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", - "number": 1, - "updated_at": "2018-01-26T18:22:20Z", - "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", - "reactions": { - "url": "https://api.github.com/teams/2403582/discussions/1/reactions", - "total_count": 5, - "+1": 3, - "-1": 1, - "laugh": 0, - "confused": 0, - "heart": 1, - "hooray": 0, - "eyes": 1, - "rocket": 1 - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "discussion-comments" - } - }, - "delete": { - "summary": "Delete a discussion comment", - "description": "Deletes a comment on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "teams" - ], - "operationId": "teams/delete-discussion-comment-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "discussion-comments" - } - } - }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { - "get": { - "summary": "List reactions for a team discussion comment", - "description": "List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", - "tags": [ - "reactions" - ], - "operationId": "reactions/list-for-team-discussion-comment-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "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.", - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, + "private_fork": { + "readOnly": true, + "description": "A temporary private fork of the advisory's repository for collaborating on a fix.", + "allOf": [ { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Simple Repository", + "description": "A GitHub repository.", "type": "object", "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "A unique identifier of the repository.", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository.", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, "name": { - "type": [ - "string", - "null" + "type": "string", + "description": "The name of the repository.", + "examples": [ + "Hello-World" ] }, - "email": { + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository.", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com.", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { "type": [ "string", "null" + ], + "description": "The repository description.", + "examples": [ + "This your first repo!" ] }, - "login": { + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { "type": "string", + "description": "A template for the API URL to download the repository as an archive.", "examples": [ - "octocat" + "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, - "id": { - "type": "integer", - "format": "int64", + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository.", "examples": [ - 1 + "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, - "node_id": { + "blobs_url": { "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", "examples": [ - "MDQ6VXNlcjE=" + "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, - "avatar_url": { + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { "type": "string", "format": "uri", + "description": "A template for the API URL to list the contributors to the repository.", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "https://api.github.com/repos/octocat/Hello-World/contributors" ] }, - "gravatar_id": { - "type": [ - "string", - "null" - ], + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository.", "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "https://api.github.com/repos/octocat/Hello-World/deployments" ] }, - "url": { + "downloads_url": { "type": "string", "format": "uri", + "description": "The API URL to list the downloads on the repository.", "examples": [ - "https://api.github.com/users/octocat" + "https://api.github.com/repos/octocat/Hello-World/downloads" ] }, - "html_url": { + "events_url": { "type": "string", "format": "uri", + "description": "The API URL to list the events of the repository.", "examples": [ - "https://github.com/octocat" + "https://api.github.com/repos/octocat/Hello-World/events" ] }, - "followers_url": { + "forks_url": { "type": "string", "format": "uri", + "description": "The API URL to list the forks of the repository.", "examples": [ - "https://api.github.com/users/octocat/followers" + "https://api.github.com/repos/octocat/Hello-World/forks" ] }, - "following_url": { + "git_commits_url": { "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository.", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, - "gists_url": { + "git_refs_url": { "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository.", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, - "starred_url": { + "git_tags_url": { "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository.", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, - "subscriptions_url": { + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { "type": "string", "format": "uri", + "description": "The API URL to get information about the languages of the repository.", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "https://api.github.com/repos/octocat/Hello-World/languages" ] }, - "organizations_url": { + "merges_url": { "type": "string", "format": "uri", + "description": "The API URL to merge branches in the repository.", "examples": [ - "https://api.github.com/users/octocat/orgs" + "https://api.github.com/repos/octocat/Hello-World/merges" ] }, - "repos_url": { + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "stargazers_url": { "type": "string", "format": "uri", + "description": "The API URL to list the stargazers on the repository.", "examples": [ - "https://api.github.com/users/octocat/repos" + "https://api.github.com/repos/octocat/Hello-World/stargazers" ] }, - "events_url": { + "statuses_url": { "type": "string", + "description": "A template for the API URL to get information about statuses of a commit.", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, - "received_events_url": { + "subscribers_url": { "type": "string", "format": "uri", + "description": "The API URL to list the subscribers on the repository.", "examples": [ - "https://api.github.com/users/octocat/received_events" + "https://api.github.com/repos/octocat/Hello-World/subscribers" ] }, - "type": { + "subscription_url": { "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository.", "examples": [ - "User" + "https://api.github.com/repos/octocat/Hello-World/subscription" ] }, - "site_admin": { - "type": "boolean" + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tags" + ] }, - "starred_at": { + "teams_url": { "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository.", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "https://api.github.com/repos/octocat/Hello-World/teams" ] }, - "user_view_type": { + "trees_url": { "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", "examples": [ - "public" + "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks" ] } }, "required": [ - "avatar_url", + "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", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", + "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" ] } - ] - }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" ], - "examples": [ - "heart" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-05-20T20:09:31Z" + "type": [ + "null" ] } }, "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] + "ghsa_id", + "cve_id", + "url", + "html_url", + "summary", + "description", + "severity", + "author", + "publisher", + "identifiers", + "state", + "created_at", + "updated_at", + "published_at", + "closed_at", + "withdrawn_at", + "submission", + "vulnerabilities", + "cvss", + "cwes", + "cwe_ids", + "credits", + "credits_detailed", + "collaborating_users", + "collaborating_teams", + "private_fork" + ], + "additionalProperties": false } }, "examples": { "default": { "value": [ { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { + "ghsa_id": "GHSA-abcd-1234-efgh", + "cve_id": "CVE-2050-00000", + "url": "https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh", + "html_url": "https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh", + "summary": "A short summary of the advisory.", + "description": "A detailed description of what the advisory entails.", + "severity": "critical", + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -172162,19 +165514,512 @@ "type": "User", "site_admin": false }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" + "publisher": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-abcd-1234-efgh" + }, + { + "type": "CVE", + "value": "CVE-2050-00000" + } + ], + "state": "published", + "created_at": "2020-01-01T00:00:00Z", + "updated_at": "2020-01-02T00:00:00Z", + "published_at": "2020-01-03T00:00:00Z", + "closed_at": null, + "withdrawn_at": null, + "submission": null, + "vulnerabilities": [ + { + "package": { + "ecosystem": "pip", + "name": "a-package" + }, + "vulnerable_version_range": ">= 1.0.0, < 1.0.1", + "patched_versions": "1.0.1", + "vulnerable_functions": [ + "function1" + ] + }, + { + "package": { + "ecosystem": "pip", + "name": "another-package" + }, + "vulnerable_version_range": ">= 1.0.0, < 1.0.2", + "patched_versions": "1.0.2", + "vulnerable_functions": [ + "function2" + ] + } + ], + "cvss": { + "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", + "score": 9.8 + }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", + "score": 9.8 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 9.3 + } + }, + "cwes": [ + { + "cwe_id": "CWE-123", + "name": "A CWE" + } + ], + "cwe_ids": [ + "CWE-123" + ], + "credits": [ + { + "login": "octocat", + "type": "analyst" + } + ], + "credits_detailed": [ + { + "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 + }, + "type": "analyst", + "state": "accepted" + } + ], + "collaborating_users": [ + { + "login": "octokitten", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "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 + } + ], + "collaborating_teams": [ + { + "name": "Justice League", + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "permission": "admin", + "parent": null + } + ], + "private_fork": null + }, + { + "ghsa_id": "GHSA-1234-5678-9012", + "cve_id": "CVE-2051-0000", + "url": "https://api.github.com/repos/repo/a-package/security-advisories/GHSA-1234-5678-9012", + "html_url": "https://github.com/repo/a-package/security/advisories/GHSA-1234-5678-9012", + "summary": "A short summary of the advisory.", + "description": "A detailed description of what the advisory entails.", + "severity": "low", + "author": { + "login": "monauser", + "id": 2, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monauser", + "html_url": "https://github.com/monauser", + "followers_url": "https://api.github.com/users/monauser/followers", + "following_url": "https://api.github.com/users/monauser/following{/other_user}", + "gists_url": "https://api.github.com/users/monauser/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monauser/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monauser/subscriptions", + "organizations_url": "https://api.github.com/users/monauser/orgs", + "repos_url": "https://api.github.com/users/monauser/repos", + "events_url": "https://api.github.com/users/monauser/events{/privacy}", + "received_events_url": "https://api.github.com/users/monauser/received_events", + "type": "User", + "site_admin": false + }, + "publisher": { + "login": "monalisa", + "id": 3, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "site_admin": false + }, + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-1234-5678-9012" + }, + { + "type": "CVE", + "value": "CVE-2051-00000" + } + ], + "state": "published", + "created_at": "2020-01-03T00:00:00Z", + "updated_at": "2020-01-04T00:00:00Z", + "published_at": "2020-01-04T00:00:00Z", + "closed_at": null, + "withdrawn_at": null, + "submission": { + "accepted": true + }, + "vulnerabilities": [ + { + "package": { + "ecosystem": "pip", + "name": "a-package" + }, + "vulnerable_version_range": ">= 1.0.0, < 1.0.1", + "patched_versions": "1.0.1", + "vulnerable_functions": [ + "function1" + ] + }, + { + "package": { + "ecosystem": "pip", + "name": "another-package" + }, + "vulnerable_version_range": ">= 1.0.0, < 1.0.2", + "patched_versions": "1.0.2", + "vulnerable_functions": [ + "function2" + ] + } + ], + "cvss": { + "vector_string": "AV:P/AC:H/PR:H/UI:R/S:U/C:N/I:L/A:N", + "score": 1.6 + }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:P/AC:H/PR:H/UI:R/S:U/C:N/I:L/A:N", + "score": 1.6 + }, + "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": 7.1 + } + }, + "cwes": [ + { + "cwe_id": "CWE-456", + "name": "A CWE 2.0" + } + ], + "cwe_ids": [ + "CWE-456" + ], + "credits": [ + { + "login": "monauser", + "type": "reporter" + } + ], + "credits_detailed": [ + { + "user": { + "login": "monauser", + "id": 2, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monauser", + "html_url": "https://github.com/monauser", + "followers_url": "https://api.github.com/users/monauser/followers", + "following_url": "https://api.github.com/users/monauser/following{/other_user}", + "gists_url": "https://api.github.com/users/monauser/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monauser/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monauser/subscriptions", + "organizations_url": "https://api.github.com/users/monauser/orgs", + "repos_url": "https://api.github.com/users/monauser/repos", + "events_url": "https://api.github.com/users/monauser/events{/privacy}", + "received_events_url": "https://api.github.com/users/monauser/received_events", + "type": "User", + "site_admin": false + }, + "type": "reporter", + "state": "accepted" + } + ], + "collaborating_users": [ + { + "login": "octokitten", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "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 + } + ], + "collaborating_teams": [ + { + "name": "Justice League", + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "permission": "admin", + "parent": null + } + ], + "private_fork": { + "id": 217723378, + "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=", + "name": "octo-repo-ghsa-1234-5678-9012", + "full_name": "octo-org/octo-repo-ghsa-1234-5678-9012", + "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-ghsa-1234-5678-9012", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012", + "archive_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/comments{/number}", + "commits_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/commits{/sha}", + "compare_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/contributors", + "deployments_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/deployments", + "downloads_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/downloads", + "events_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/events", + "forks_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/forks", + "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/tags{/sha}", + "hooks_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/hooks", + "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/issues{/number}", + "keys_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/labels{/name}", + "languages_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/languages", + "merges_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/merges", + "milestones_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/pulls{/number}", + "releases_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/stargazers", + "statuses_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/subscribers", + "subscription_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/subscription", + "tags_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/tags", + "teams_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/teams", + "trees_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/trees{/sha}" + } } ] } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", + } + }, + "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "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" + } + } } } } @@ -172183,20 +166028,201 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" + "category": "security-advisories", + "subcategory": "repository-advisories" } - }, - "post": { - "summary": "Create reaction for a team discussion comment", - "description": "Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + } + }, + "/orgs/{org}/security-managers": { + "get": { + "summary": "List security manager teams", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the \"[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)\" endpoints instead.", "tags": [ - "reactions" + "orgs" ], - "operationId": "reactions/create-for-team-discussion-comment-in-org", + "operationId": "orgs/list-security-manager-teams", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment" + "url": "https://docs.github.com/rest/orgs/security-managers#list-security-manager-teams" + }, + "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", + "items": { + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + }, + "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 + } + ] + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "security-managers", + "deprecationDate": "2024-12-01", + "removalDate": "2026-01-01" + }, + "deprecated": true + } + }, + "/orgs/{org}/security-managers/teams/{team_slug}": { + "put": { + "summary": "Add a security manager team", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the \"[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)\" endpoints instead.", + "tags": [ + "orgs" + ], + "operationId": "orgs/add-security-manager-team", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/security-managers#add-a-security-manager-team" }, "parameters": [ { @@ -172216,581 +166242,270 @@ "schema": { "type": "string" } - }, + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "security-managers", + "deprecationDate": "2024-12-01", + "removalDate": "2026-01-01" + }, + "deprecated": true + }, + "delete": { + "summary": "Remove a security manager team", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the \"[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)\" endpoints instead.", + "tags": [ + "orgs" + ], + "operationId": "orgs/remove-security-manager-team", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/security-managers#remove-a-security-manager-team" + }, + "parameters": [ { - "name": "discussion_number", - "description": "The number that identifies the discussion.", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } }, { - "name": "comment_number", - "description": "The number that identifies the comment.", + "name": "team_slug", + "description": "The slug of the team name.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], - "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 team discussion comment.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - "required": [ - "content" - ] - }, - "examples": { - "default": { - "value": { - "content": "heart" - } - } - } - } + "responses": { + "204": { + "description": "Response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "security-managers", + "deprecationDate": "2024-12-01", + "removalDate": "2026-01-01" + }, + "deprecated": true + } + }, + "/orgs/{org}/settings/billing/actions": { + "get": { + "summary": "Get GitHub Actions billing for an organization", + "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 returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint.", + "operationId": "billing/get-github-actions-billing-org", + "tags": [ + "billing" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/billing/billing#get-github-actions-billing-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 when the reaction type has already been added to this team discussion comment", + "description": "Response", "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": { + "total_minutes_used": { "type": "integer", - "examples": [ - 1 - ] + "description": "The sum of the free and paid GitHub Actions minutes used." }, - "node_id": { - "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" - ] + "total_paid_minutes_used": { + "type": "integer", + "description": "The total paid GitHub Actions minutes used." }, - "user": { - "anyOf": [ - { - "type": "null" + "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." }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + "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." } - ] - }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "examples": [ - "heart" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-05-20T20:09:31Z" - ] + } } }, "required": [ - "id", - "node_id", - "user", - "content", - "created_at" + "total_minutes_used", + "total_paid_minutes_used", + "included_minutes", + "minutes_used_breakdown" ] }, "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" + "total_minutes_used": 305, + "total_paid_minutes_used": 0, + "included_minutes": 3000, + "minutes_used_breakdown": { + "UBUNTU": 205, + "MACOS": 10, + "WINDOWS": 90 + } } } } } } - }, - "201": { + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "billing", + "subcategory": "billing" + } + } + }, + "/orgs/{org}/settings/billing/packages": { + "get": { + "summary": "Get GitHub Packages billing for an organization", + "description": "Gets the free and paid storage used for GitHub Packages in gigabytes.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint.", + "operationId": "billing/get-github-packages-billing-org", + "tags": [ + "billing" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/billing/billing#get-github-packages-billing-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": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", "type": "object", "properties": { - "id": { + "total_gigabytes_bandwidth_used": { "type": "integer", - "examples": [ - 1 - ] + "description": "Sum of the free and paid storage space (GB) for GitHuub Packages." }, - "node_id": { - "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" - ] + "total_paid_gigabytes_bandwidth_used": { + "type": "integer", + "description": "Total paid storage space (GB) for GitHuub Packages." }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "examples": [ - "heart" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-05-20T20:09:31Z" - ] + "included_gigabytes_bandwidth": { + "type": "integer", + "description": "Free storage space (GB) for GitHub Packages." } }, "required": [ - "id", - "node_id", - "user", - "content", - "created_at" + "total_gigabytes_bandwidth_used", + "total_paid_gigabytes_bandwidth_used", + "included_gigabytes_bandwidth" ] }, "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" + "total_gigabytes_bandwidth_used": 50, + "total_paid_gigabytes_bandwidth_used": 40, + "included_gigabytes_bandwidth": 10 } } } @@ -172800,23 +166515,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" + "enabledForGitHubApps": false, + "category": "billing", + "subcategory": "billing" } } }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { - "delete": { - "summary": "Delete team discussion comment reaction", - "description": "> [!NOTE]\n> You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "/orgs/{org}/settings/billing/shared-storage": { + "get": { + "summary": "Get shared storage billing for an organization", + "description": "Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint.", + "operationId": "billing/get-shared-storage-billing-org", "tags": [ - "reactions" + "billing" ], - "operationId": "reactions/delete-for-team-discussion-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#delete-team-discussion-comment-reaction" + "url": "https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-an-organization" }, "parameters": [ { @@ -172827,68 +166542,67 @@ "schema": { "type": "string" } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "reaction_id", - "description": "The unique identifier of the reaction.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { - "204": { - "description": "Response" + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "days_left_in_billing_cycle": { + "type": "integer", + "description": "Numbers of days left in billing cycle." + }, + "estimated_paid_storage_for_month": { + "type": "integer", + "description": "Estimated storage space (GB) used in billing cycle." + }, + "estimated_storage_for_month": { + "type": "integer", + "description": "Estimated sum of free and paid storage space (GB) used in billing cycle." + } + }, + "required": [ + "days_left_in_billing_cycle", + "estimated_paid_storage_for_month", + "estimated_storage_for_month" + ] + }, + "examples": { + "default": { + "value": { + "days_left_in_billing_cycle": 20, + "estimated_paid_storage_for_month": 15, + "estimated_storage_for_month": 40 + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" + "enabledForGitHubApps": false, + "category": "billing", + "subcategory": "billing" } } }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { + "/orgs/{org}/settings/network-configurations": { "get": { - "summary": "List reactions for a team discussion", - "description": "List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "summary": "List hosted compute network configurations for an organization", + "description": "Lists all hosted compute network configurations configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint.", "tags": [ - "reactions" + "hosted-compute" ], - "operationId": "reactions/list-for-team-discussion-in-org", + "operationId": "hosted-compute/list-network-configurations-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion" + "url": "https://docs.github.com/rest/orgs/network-configurations#list-hosted-compute-network-configurations-for-an-organization" }, "parameters": [ { @@ -172900,43 +166614,6 @@ "type": "string" } }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "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.", - "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).\"", @@ -172962,263 +166639,103 @@ "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" + "type": "object", + "required": [ + "total_count", + "network_configurations" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "network_configurations": { + "type": "array", + "items": { + "title": "Hosted compute network configuration", + "description": "A hosted compute network configuration.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the network configuration.", + "type": "string", + "examples": [ + "123ABC456DEF789" + ] }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + "name": { + "description": "The name of the network configuration.", + "type": "string", + "examples": [ + "my-network-configuration" + ] + }, + "compute_service": { + "description": "The hosted compute service the network configuration supports.", + "type": "string", + "enum": [ + "none", + "actions", + "codespaces" + ] + }, + "network_settings_ids": { + "description": "The unique identifier of each network settings in the configuration.", + "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" + "examples": [ + "123ABC456DEF789" + ] + }, + "created_on": { + "description": "The time at which the network configuration was created, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2024-04-26T11:31:07Z" ] } - ] - }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "examples": [ - "heart" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-05-20T20:09:31Z" + }, + "required": [ + "id", + "name", + "created_on" ] } - }, - "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 + "value": { + "total_count": 2, + "network_configurations": [ + { + "id": "123456789ABCDEF", + "name": "My network configuration", + "compute_service": "actions", + "network_settings_ids": [ + "23456789ABDCEF1", + "3456789ABDCEF12" + ], + "created_on": "2022-10-09T23:39:01Z" }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" - } - ] + { + "id": "456789ABDCEF123", + "name": "My other configuration", + "compute_service": "none", + "network_settings_ids": [ + "56789ABDCEF1234", + "6789ABDCEF12345" + ], + "created_on": "2023-04-26T15:23:37Z" + } + ] + } } } } @@ -173236,20 +166753,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" + "category": "orgs", + "subcategory": "network-configurations" } }, "post": { - "summary": "Create reaction for a team discussion", - "description": "Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "summary": "Create a hosted compute network configuration for an organization", + "description": "Creates a hosted compute network configuration for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint.", "tags": [ - "reactions" + "hosted-compute" ], - "operationId": "reactions/create-for-team-discussion-in-org", + "operationId": "hosted-compute/create-network-configuration-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion" + "url": "https://docs.github.com/rest/orgs/network-configurations#create-a-hosted-compute-network-configuration-for-an-organization" }, "parameters": [ { @@ -173260,24 +166777,6 @@ "schema": { "type": "string" } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "requestBody": { @@ -173287,29 +166786,41 @@ "schema": { "type": "object", "properties": { - "content": { + "name": { + "description": "Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.", + "type": "string" + }, + "compute_service": { + "description": "The hosted compute service to use for the network configuration.", "type": "string", - "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion.", "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" + "none", + "actions" ] + }, + "network_settings_ids": { + "type": "array", + "minItems": 1, + "maxItems": 1, + "description": "The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified.", + "items": { + "type": "string" + } } }, "required": [ - "content" + "name", + "network_settings_ids" ] }, "examples": { "default": { "value": { - "content": "heart" + "name": "my-network-configuration", + "network_settings_ids": [ + "23456789ABDCEF1" + ], + "compute_service": "actions" } } } @@ -173317,550 +166828,228 @@ } }, "responses": { - "200": { + "201": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "title": "Hosted compute network configuration", + "description": "A hosted compute network configuration.", "type": "object", "properties": { "id": { - "type": "integer", + "description": "The unique identifier of the network configuration.", + "type": "string", "examples": [ - 1 + "123ABC456DEF789" ] }, - "node_id": { + "name": { + "description": "The name of the network configuration.", "type": "string", "examples": [ - "MDg6UmVhY3Rpb24x" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "my-network-configuration" ] }, - "content": { - "description": "The reaction to use", + "compute_service": { + "description": "The hosted compute service the network configuration supports.", "type": "string", "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], + "none", + "actions", + "codespaces" + ] + }, + "network_settings_ids": { + "description": "The unique identifier of each network settings in the configuration.", + "type": "array", + "items": { + "type": "string" + }, "examples": [ - "heart" + "123ABC456DEF789" ] }, - "created_at": { - "type": "string", + "created_on": { + "description": "The time at which the network configuration was created, in ISO 8601 format.", + "type": [ + "string", + "null" + ], "format": "date-time", "examples": [ - "2016-05-20T20:09:31Z" + "2024-04-26T11:31:07Z" ] } }, "required": [ "id", - "node_id", - "user", - "content", - "created_at" + "name", + "created_on" ] }, "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" + "id": "123456789ABCDEF", + "name": "My network configuration", + "compute_service": "actions", + "network_settings_ids": [ + "23456789ABDCEF1", + "3456789ABDCEF12" + ], + "created_on": "2022-10-09T23:39:01Z" } } } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "network-configurations" + } + } + }, + "/orgs/{org}/settings/network-configurations/{network_configuration_id}": { + "get": { + "summary": "Get a hosted compute network configuration for an organization", + "description": "Gets a hosted compute network configuration configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint.", + "tags": [ + "hosted-compute" + ], + "operationId": "hosted-compute/get-network-configuration-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "201": { + { + "name": "network_configuration_id", + "description": "Unique identifier of the hosted compute network configuration.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "title": "Hosted compute network configuration", + "description": "A hosted compute network configuration.", "type": "object", "properties": { "id": { - "type": "integer", + "description": "The unique identifier of the network configuration.", + "type": "string", "examples": [ - 1 + "123ABC456DEF789" ] }, - "node_id": { + "name": { + "description": "The name of the network configuration.", "type": "string", "examples": [ - "MDg6UmVhY3Rpb24x" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "my-network-configuration" ] }, - "content": { - "description": "The reaction to use", + "compute_service": { + "description": "The hosted compute service the network configuration supports.", "type": "string", "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], + "none", + "actions", + "codespaces" + ] + }, + "network_settings_ids": { + "description": "The unique identifier of each network settings in the configuration.", + "type": "array", + "items": { + "type": "string" + }, "examples": [ - "heart" + "123ABC456DEF789" ] }, - "created_at": { - "type": "string", + "created_on": { + "description": "The time at which the network configuration was created, in ISO 8601 format.", + "type": [ + "string", + "null" + ], "format": "date-time", "examples": [ - "2016-05-20T20:09:31Z" + "2024-04-26T11:31:07Z" ] } }, "required": [ "id", - "node_id", - "user", - "content", - "created_at" + "name", + "created_on" ] }, "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" + "id": "123456789ABCDEF", + "name": "My network configuration", + "compute_service": "actions", + "network_settings_ids": [ + "23456789ABDCEF1", + "3456789ABDCEF12" + ], + "created_on": "2022-10-09T23:39:01Z" } } } } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } } } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "reactions", - "subcategory": "reactions" + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "network-configurations" } - } - }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { - "delete": { - "summary": "Delete team discussion reaction", - "description": "> [!NOTE]\n> You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + }, + "patch": { + "summary": "Update a hosted compute network configuration for an organization", + "description": "Updates a hosted compute network configuration for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint.", "tags": [ - "reactions" + "hosted-compute" ], - "operationId": "reactions/delete-for-team-discussion", + "operationId": "hosted-compute/update-network-configuration-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#delete-team-discussion-reaction" + "url": "https://docs.github.com/rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization" }, "parameters": [ { @@ -173873,30 +167062,173 @@ } }, { - "name": "team_slug", - "description": "The slug of the team name.", + "name": "network_configuration_id", + "description": "Unique identifier of the hosted compute network configuration.", "in": "path", "required": true, "schema": { "type": "string" } - }, + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.", + "type": "string" + }, + "compute_service": { + "description": "The hosted compute service to use for the network configuration.", + "type": "string", + "enum": [ + "none", + "actions" + ] + }, + "network_settings_ids": { + "type": "array", + "minItems": 0, + "maxItems": 1, + "description": "The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified.", + "items": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": { + "name": "my-network-configuration", + "network_settings_ids": [ + "23456789ABDCEF1" + ], + "compute_service": "actions" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Hosted compute network configuration", + "description": "A hosted compute network configuration.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the network configuration.", + "type": "string", + "examples": [ + "123ABC456DEF789" + ] + }, + "name": { + "description": "The name of the network configuration.", + "type": "string", + "examples": [ + "my-network-configuration" + ] + }, + "compute_service": { + "description": "The hosted compute service the network configuration supports.", + "type": "string", + "enum": [ + "none", + "actions", + "codespaces" + ] + }, + "network_settings_ids": { + "description": "The unique identifier of each network settings in the configuration.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "123ABC456DEF789" + ] + }, + "created_on": { + "description": "The time at which the network configuration was created, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2024-04-26T11:31:07Z" + ] + } + }, + "required": [ + "id", + "name", + "created_on" + ] + }, + "examples": { + "default": { + "value": { + "id": "123456789ABCDEF", + "name": "My network configuration", + "compute_service": "actions", + "network_settings_ids": [ + "23456789ABDCEF1", + "3456789ABDCEF12" + ], + "created_on": "2022-10-09T23:39:01Z" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "network-configurations" + } + }, + "delete": { + "summary": "Delete a hosted compute network configuration from an organization", + "description": "Deletes a hosted compute network configuration from an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint.", + "tags": [ + "hosted-compute" + ], + "operationId": "hosted-compute/delete-network-configuration-from-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization" + }, + "parameters": [ { - "name": "discussion_number", - "description": "The number that identifies the discussion.", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } }, { - "name": "reaction_id", - "description": "The unique identifier of the reaction.", + "name": "network_configuration_id", + "description": "Unique identifier of the hosted compute network configuration.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], @@ -173908,22 +167240,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" + "category": "orgs", + "subcategory": "network-configurations" } } }, - "/orgs/{org}/teams/{team_slug}/invitations": { + "/orgs/{org}/settings/network-settings/{network_settings_id}": { "get": { - "summary": "List pending team invitations", - "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`.", + "summary": "Get a hosted compute network settings resource for an organization", + "description": "Gets a hosted compute network settings resource configured for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint.", "tags": [ - "teams" + "hosted-compute" ], - "operationId": "teams/list-pending-invitations-in-org", + "operationId": "hosted-compute/get-network-settings-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/members#list-pending-team-invitations" + "url": "https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization" }, "parameters": [ { @@ -173936,31 +167268,13 @@ } }, { - "name": "team_slug", - "description": "The slug of the team name.", + "name": "network_settings_id", + "description": "Unique identifier of the hosted compute network settings.", "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": { @@ -173969,286 +167283,62 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Organization Invitation", - "description": "Organization Invitation", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "role": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "failed_at": { - "type": [ - "string", - "null" - ] - }, - "failed_reason": { - "type": [ - "string", - "null" - ] - }, - "inviter": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "team_count": { - "type": "integer" - }, - "node_id": { - "type": "string", - "examples": [ - "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" - ] - }, - "invitation_teams_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/organizations/16/invitations/1/teams\"" - ] - }, - "invitation_source": { - "type": "string", - "examples": [ - "\"member\"" - ] - } + "title": "Hosted compute network settings resource", + "description": "A hosted compute network settings resource.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the network settings resource.", + "type": "string", + "examples": [ + "220F78DACB92BBFBC5E6F22DE1CCF52309D" + ] }, - "required": [ - "id", - "login", - "email", - "role", - "created_at", - "inviter", - "team_count", - "invitation_teams_url", - "node_id" - ] - } + "network_configuration_id": { + "description": "The identifier of the network configuration that is using this settings resource.", + "type": "string", + "examples": [ + "934E208B3EE0BD60CF5F752C426BFB53562" + ] + }, + "name": { + "description": "The name of the network settings resource.", + "type": "string", + "examples": [ + "my-network-settings" + ] + }, + "subnet_id": { + "description": "The subnet this network settings resource is configured for.", + "type": "string", + "examples": [ + "/subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet" + ] + }, + "region": { + "description": "The location of the subnet this network settings resource is configured for.", + "type": "string", + "examples": [ + "eastus" + ] + } + }, + "required": [ + "id", + "name", + "subnet_id", + "region" + ] }, "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", - "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 - }, - "team_count": 2, - "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams", - "invitation_source": "member" - } - ] + "value": { + "id": "220F78DACB92BBFBC5E6F22DE1CCF52309D", + "network_configuration_id": "934E208B3EE0BD60CF5F752C426BFB53562", + "name": "my_network_settings", + "subnet_id": "/subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet", + "region": "eastus" + } } } } @@ -174266,22 +167356,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "members" + "category": "orgs", + "subcategory": "network-configurations" } } }, - "/orgs/{org}/teams/{team_slug}/members": { + "/orgs/{org}/team/{team_slug}/copilot/metrics": { "get": { - "summary": "List team members", - "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.", + "summary": "Get Copilot metrics for a team", + "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 team had **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 containing the team within GitHub settings.\nOnly organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team.\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": [ - "teams" + "copilot" ], - "operationId": "teams/list-members-in-org", + "operationId": "copilot/copilot-metrics-for-team", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/members#list-team-members" + "url": "https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team" }, "parameters": [ { @@ -174303,27 +167393,21 @@ } }, { - "name": "role", - "description": "Filters members returned by their role in the team.", + "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", - "enum": [ - "member", - "maintainer", - "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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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": "integer", - "default": 30 + "type": "string" } }, { @@ -174334,6 +167418,15 @@ "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": { @@ -174344,309 +167437,528 @@ "schema": { "type": "array", "items": { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { + "date": { "type": "string", - "examples": [ - "octocat" - ] + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." }, - "id": { + "total_active_users": { "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "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." }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] + "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." }, - "gravatar_id": { + "copilot_ide_code_completions": { "type": [ - "string", + "object", "null" ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "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", + "null" + ], + "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." + } + } + } + } + } + } + } + } + } + } + } }, - "site_admin": { - "type": "boolean" + "copilot_ide_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in the IDE.", + "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", + "null" + ], + "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." + } + } + } + } + } + } + } + } }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "copilot_dotcom_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in GitHub.com", + "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", + "null" + ], + "description": "The training date for the custom model (if applicable)." + }, + "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." + } + } + } + } + } }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] + "copilot_dotcom_pull_requests": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot for pull requests.", + "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", + "null" + ], + "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": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + "date" + ], + "additionalProperties": true } }, "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 + "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 + } + ] + } + ] + } } ] } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { "schema": { - "type": "string" + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "members" - } - } - }, - "/orgs/{org}/teams/{team_slug}/memberships/{username}": { - "get": { - "summary": "Get team membership for a user", - "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team).", - "tags": [ - "teams" - ], - "operationId": "teams/get-membership-for-user-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/members#get-team-membership-for-a-user" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "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": { - "200": { - "description": "Response", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "title": "Team Membership", - "description": "Team Membership", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri" + "message": { + "type": "string" }, - "role": { - "description": "The role of the user in the team.", - "enum": [ - "member", - "maintainer" - ], - "default": "member", - "type": "string", - "examples": [ - "member" - ] + "documentation_url": { + "type": "string" }, - "state": { - "description": "The state of the user's membership in the team.", - "type": "string", - "enum": [ - "active", - "pending" - ] - } - }, - "required": [ - "role", - "state", - "url" - ] - }, - "examples": { - "response-if-user-is-a-team-maintainer": { - "summary": "Response if user is a team maintainer", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "maintainer", - "state": "active" + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } @@ -174654,220 +167966,77 @@ } }, "404": { - "description": "if user has no team membership" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "members" - } - }, - "put": { - "summary": "Add or update team membership for a user", - "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", - "tags": [ - "teams" - ], - "operationId": "teams/add-or-update-membership-for-user-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "role": { - "type": "string", - "description": "The role that this user should have in the team.", - "enum": [ - "member", - "maintainer" - ], - "default": "member" - } - } - }, - "examples": { - "default": { - "summary": "Add or update team membership for an organization member", - "value": { - "role": "maintainer" + "description": "Resource not found", + "content": { + "application/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": { - "200": { - "description": "Response", + }, + "422": { + "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.", "content": { "application/json": { "schema": { - "title": "Team Membership", - "description": "Team Membership", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri" + "message": { + "type": "string" }, - "role": { - "description": "The role of the user in the team.", - "enum": [ - "member", - "maintainer" - ], - "default": "member", - "type": "string", - "examples": [ - "member" - ] + "documentation_url": { + "type": "string" }, - "state": { - "description": "The state of the user's membership in the team.", - "type": "string", - "enum": [ - "active", - "pending" - ] - } - }, - "required": [ - "role", - "state", - "url" - ] - }, - "examples": { - "response-if-users-membership-with-team-is-now-pending": { - "summary": "Response if user's membership with team is now pending", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "pending" + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } - }, - "403": { - "description": "Forbidden if team synchronization is set up" - }, - "422": { - "description": "Unprocessable Entity if you attempt to add an organization to a team" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "members" - } - }, - "delete": { - "summary": "Remove team membership for a user", - "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", - "tags": [ - "teams" - ], - "operationId": "teams/remove-membership-for-user-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "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 if team synchronization is set up" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "members" + "category": "copilot", + "subcategory": "copilot-metrics" } } }, - "/orgs/{org}/teams/{team_slug}/projects": { + "/orgs/{org}/teams": { "get": { - "summary": "List team projects", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "summary": "List teams", + "description": "Lists all teams in an organization that are visible to the authenticated user.", "tags": [ "teams" ], - "operationId": "teams/list-projects-in-org", + "operationId": "teams/list", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#list-team-projects" + "url": "https://docs.github.com/rest/teams/teams#list-teams" }, "parameters": [ { @@ -174879,15 +168048,6 @@ "type": "string" } }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "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).\"", @@ -174915,22 +168075,10 @@ "schema": { "type": "array", "items": { - "title": "Team Project", - "description": "A team's access to a project.", + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, "id": { "type": "integer" }, @@ -174940,235 +168088,200 @@ "name": { "type": "string" }, - "body": { + "slug": { + "type": "string" + }, + "description": { "type": [ "string", "null" ] }, - "number": { - "type": "integer" + "privacy": { + "type": "string" }, - "state": { + "notification_setting": { "type": "string" }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", + "permission": { + "type": "string" + }, + "permissions": { "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] + "pull": { + "type": "boolean" }, - "type": { - "type": "string", - "examples": [ - "User" - ] + "triage": { + "type": "boolean" }, - "site_admin": { + "push": { "type": "boolean" }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "maintain": { + "type": "boolean" }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] + "admin": { + "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" + "pull", + "triage", + "push", + "maintain", + "admin" ] }, - "created_at": { - "type": "string" + "url": { + "type": "string", + "format": "uri" }, - "updated_at": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", + "members_url": { "type": "string" }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", - "type": "boolean" + "repositories_url": { + "type": "string", + "format": "uri" }, - "permissions": { - "type": "object", - "properties": { - "read": { - "type": "boolean" - }, - "write": { - "type": "boolean" + "parent": { + "anyOf": [ + { + "type": "null" }, - "admin": { - "type": "boolean" + { + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] } - }, - "required": [ - "read", - "write", - "admin" ] } }, "required": [ - "owner_url", - "url", - "html_url", - "columns_url", "id", "node_id", + "url", + "members_url", "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" ] } }, @@ -175176,45 +168289,19 @@ "default": { "value": [ { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "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 - }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false - } + "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 } ] } @@ -175229,30 +168316,51 @@ } } } + }, + "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": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { - "get": { - "summary": "Check team permissions for a project", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "subcategory": "teams" + } + }, + "post": { + "summary": "Create a team", + "description": "To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://docs.github.com/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/about-teams)\".", "tags": [ "teams" ], - "operationId": "teams/check-permissions-for-project-in-org", + "operationId": "teams/create", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project" + "url": "https://docs.github.com/rest/teams/teams#create-a-team" }, "parameters": [ { @@ -175263,95 +168371,344 @@ "schema": { "type": "string" } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the team." + }, + "description": { + "type": "string", + "description": "The description of the team." + }, + "maintainers": { + "type": "array", + "description": "List GitHub usernames for organization members who will become team maintainers.", + "items": { + "type": "string" + } + }, + "repo_names": { + "type": "array", + "description": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.", + "items": { + "type": "string" + } + }, + "privacy": { + "type": "string", + "description": "The level of privacy this team should have. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \nDefault: `secret` \n**For a parent or child team:** \n * `closed` - visible to all members of this organization. \nDefault for child team: `closed`", + "enum": [ + "secret", + "closed" + ] + }, + "notification_setting": { + "type": "string", + "description": "The notification setting the team has chosen. The options are: \n * `notifications_enabled` - team members receive notifications when the team is @mentioned. \n * `notifications_disabled` - no one receives notifications. \nDefault: `notifications_enabled`", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, + "permission": { + "type": "string", + "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.", + "enum": [ + "pull", + "push" + ], + "default": "pull" + }, + "parent_team_id": { + "type": "integer", + "description": "The ID of a team to set as the parent team." + } + }, + "required": [ + "name" + ] + }, + "examples": { + "default": { + "value": { + "name": "Justice League", + "description": "A great team", + "permission": "push", + "notification_setting": "notifications_enabled", + "privacy": "closed" + } + } + } + } + } + }, "responses": { - "200": { + "201": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Team Project", - "description": "A team's access to a project.", + "title": "Full Team", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "owner_url": { - "type": "string" + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] }, "url": { - "type": "string" + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] }, "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] }, "name": { - "type": "string" + "description": "Name of the team", + "type": "string", + "examples": [ + "Developers" + ] }, - "body": { + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "description": { "type": [ "string", "null" + ], + "examples": [ + "A great team." ] }, - "number": { - "type": "integer" + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": [ + "closed", + "secret" + ], + "examples": [ + "closed" + ] }, - "state": { - "type": "string" + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "examples": [ + "notifications_enabled" + ] }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "push" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "parent": { + "anyOf": [ + { + "type": "null" }, - "email": { - "type": [ - "string", - "null" + { + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" ] - }, + } + ] + }, + "members_count": { + "type": "integer", + "examples": [ + 3 + ] + }, + "repos_count": { + "type": "integer", + "examples": [ + 10 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-14T16:53:42Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-08-17T12:37:15Z" + ] + }, + "organization": { + "title": "Team Organization", + "description": "Team Organization", + "type": "object", + "properties": { "login": { "type": "string", "examples": [ - "octocat" + "github" ] }, "id": { "type": "integer", - "format": "int64", "examples": [ 1 ] @@ -175359,233 +168716,440 @@ "node_id": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "MDEyOk9yZ2FuaXphdGlvbjE=" ] }, - "avatar_url": { + "url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "https://api.github.com/orgs/github" ] }, - "gravatar_id": { - "type": [ - "string", - "null" - ], + "repos_url": { + "type": "string", + "format": "uri", "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "https://api.github.com/orgs/github/repos" ] }, - "url": { + "events_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "https://api.github.com/orgs/github/events" ] }, - "html_url": { + "hooks_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/octocat" + "https://api.github.com/orgs/github/hooks" ] }, - "followers_url": { + "issues_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "https://api.github.com/orgs/github/issues" ] }, - "following_url": { + "members_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "https://api.github.com/orgs/github/members{/member}" ] }, - "gists_url": { + "public_members_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "https://api.github.com/orgs/github/public_members{/member}" ] }, - "starred_url": { + "avatar_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "https://github.com/images/error/octocat_happy.gif" ] }, - "subscriptions_url": { + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + }, + "name": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "github" ] }, - "organizations_url": { + "company": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "GitHub" ] }, - "repos_url": { + "blog": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "https://github.com/blog" ] }, - "events_url": { + "location": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "San Francisco" ] }, - "received_events_url": { + "email": { + "type": "string", + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "github" + ] + }, + "is_verified": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_organization_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_repository_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "https://github.com/octocat" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" ] }, "type": { "type": "string", "examples": [ - "User" + "Organization" ] }, - "site_admin": { - "type": "boolean" + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] }, - "starred_at": { - "type": "string", + "owned_private_repos": { + "type": "integer", "examples": [ - "\"2020-07-09T00:17:55Z\"" + 100 ] }, - "user_view_type": { + "private_gists": { + "type": [ + "integer", + "null" + ], + "examples": [ + 81 + ] + }, + "disk_usage": { + "type": [ + "integer", + "null" + ], + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": [ + "integer", + "null" + ], + "examples": [ + 8 + ] + }, + "billing_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "org@example.com" + ] + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": [ + "string", + "null" + ] + }, + "members_can_create_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "two_factor_requirement_enabled": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "members_allowed_repository_creation_type": { "type": "string", "examples": [ - "public" + "all" + ] + }, + "members_can_create_public_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_public_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_fork_private_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", + "login", + "url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", "repos_url", - "site_admin", - "starred_url", - "subscriptions_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", - "url" + "created_at", + "updated_at", + "archived_at" ] }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", - "type": "string" - }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", - "type": "boolean" - }, - "permissions": { - "type": "object", - "properties": { - "read": { - "type": "boolean" - }, - "write": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "read", - "write", - "admin" + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ - "owner_url", - "url", - "html_url", - "columns_url", "id", "node_id", + "url", + "members_url", "name", - "body", - "number", - "state", - "creator", + "description", + "permission", + "html_url", + "repositories_url", + "slug", "created_at", "updated_at", - "permissions" + "members_count", + "repos_count", + "organization" ] }, "examples": { "default": { "value": { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "creator": { - "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, + "members_count": 3, + "repos_count": 10, + "created_at": "2017-07-14T16:53:42Z", + "updated_at": "2017-08-17T12:37:15Z", + "organization": { + "login": "github", "id": 1, - "node_id": "MDQ6VXNlcjE=", + "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", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "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", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "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-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" } } } @@ -175593,1232 +169157,103 @@ } } }, - "404": { - "description": "Not Found if project is not managed by this team" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "put": { - "summary": "Add or update team project permissions", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/add-or-update-project-permissions-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": [ - "object", - "null" - ], - "properties": { - "permission": { - "type": "string", - "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", - "enum": [ - "read", - "write", - "admin" - ] - } - } - }, - "examples": { - "default": { - "summary": "Updates the permissions for the team to write for the project", - "value": { - "permission": "write" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden if the project is not owned by the 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" - } - } - }, - "examples": { - "response-if-the-project-is-not-owned-by-the-organization": { - "value": { - "message": "Must have admin rights to Repository.", - "documentation_url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Remove a project from a team", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/remove-project-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/orgs/{org}/teams/{team_slug}/repos": { - "get": { - "summary": "List team repositories", - "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", - "tags": [ - "teams" - ], - "operationId": "teams/list-repos-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#list-team-repositories" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "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": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "examples": [ - "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", + }, + "errors": { + "type": "array", + "items": { "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# 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", - "null" - ], - "format": "uri" - } - }, "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" + "code" ], "properties": { - "key": { - "type": "string" - }, - "name": { + "resource": { "type": "string" }, - "spdx_id": { + "field": { "type": "string" }, - "url": { + "message": { "type": "string" }, - "node_id": { + "code": { "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "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" - ] - } - } + "index": { + "type": "integer" }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" + }, + { + "type": [ + "integer", + "null" ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "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": [ - "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": 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": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "has_discussions": false, - "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 - }, - "security_and_analysis": { - "advanced_security": { - "status": "enabled" - }, - "secret_scanning": { - "status": "enabled" - }, - "secret_scanning_push_protection": { - "status": "disabled" - }, - "secret_scanning_non_provider_patterns": { - "status": "disabled" + ] } } } - ] + } } } } - }, - "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" + } + } } } } @@ -176832,17 +169267,17 @@ } } }, - "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": { + "/orgs/{org}/teams/{team_slug}": { "get": { - "summary": "Check team permissions for a repository", - "description": "Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header.\n\nIf a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.\n\nIf the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", + "summary": "Get a team by name", + "description": "Gets a team using the team's `slug`. To create the `slug`, GitHub replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `\"My TEam Näme\"` would become `my-team-name`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`.", "tags": [ "teams" ], - "operationId": "teams/check-permissions-for-repo-in-org", + "operationId": "teams/get-by-name", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository" + "url": "https://docs.github.com/rest/teams/teams#get-a-team-by-name" }, "parameters": [ { @@ -176862,38 +169297,20 @@ "schema": { "type": "string" } - }, - { - "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": "Alternative response with repository permissions", + "description": "Response", "content": { "application/json": { "schema": { - "title": "Team Repository", - "description": "A team's access to a repository.", + "title": "Full Team", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { - "description": "Unique identifier of the repository", + "description": "Unique identifier of the team", "type": "integer", "examples": [ 42 @@ -176902,149 +169319,101 @@ "node_id": { "type": "string", "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" ] }, "name": { - "description": "The name of the repository.", + "description": "Name of the team", "type": "string", "examples": [ - "Team Environment" + "Developers" ] }, - "full_name": { + "slug": { "type": "string", "examples": [ - "octocat/Hello-World" + "justice-league" ] }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." ] }, - "forks": { - "type": "integer" + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": [ + "closed", + "secret" + ], + "examples": [ + "closed" + ] }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "examples": [ + "notifications_enabled" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ "push" ] }, - "role_name": { + "members_url": { "type": "string", "examples": [ - "admin" + "https://api.github.com/organizations/1/team/1/members{/member}" ] }, - "owner": { + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "parent": { "anyOf": [ { "type": "null" }, { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { + "description": "Unique identifier of the team", "type": "integer", - "format": "int64", "examples": [ 1 ] @@ -177052,959 +169421,618 @@ "node_id": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "MDQ6VGVhbTE=" ] }, "url": { + "description": "URL for the team", "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" + "https://api.github.com/organizations/1/team/1" ] }, - "followers_url": { + "members_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "https://api.github.com/organizations/1/team/1/members{/member}" ] }, - "following_url": { + "name": { + "description": "Name of the team", "type": "string", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "Justice League" ] }, - "gists_url": { - "type": "string", + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "A great team." ] }, - "starred_url": { + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "admin" ] }, - "subscriptions_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "closed" ] }, - "organizations_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "notifications_enabled" ] }, - "repos_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "https://github.com/orgs/rails/teams/core" ] }, - "received_events_url": { + "repositories_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" + "https://api.github.com/organizations/1/team/1/repos" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { + "slug": { "type": "string", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "justice-league" ] }, - "user_view_type": { + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ - "public" + "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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" ] } ] }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", + "members_count": { + "type": "integer", "examples": [ - "https://github.com/octocat/Hello-World.git" + 3 ] }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", + "repos_count": { + "type": "integer", "examples": [ - "git:git.example.com/octocat/Hello-World" + 10 ] }, - "hooks_url": { + "created_at": { "type": "string", - "format": "uri", + "format": "date-time", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" + "2017-07-14T16:53:42Z" ] }, - "svn_url": { + "updated_at": { "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", + "format": "date-time", "examples": [ - 80 + "2017-08-17T12:37:15Z" ] }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "type": "integer", - "examples": [ - 108 + "organization": { + "title": "Team Organization", + "description": "Team Organization", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + }, + "name": { + "type": "string", + "examples": [ + "github" + ] + }, + "company": { + "type": "string", + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": "string", + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": "string", + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "github" + ] + }, + "is_verified": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_organization_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_repository_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "private_gists": { + "type": [ + "integer", + "null" + ], + "examples": [ + 81 + ] + }, + "disk_usage": { + "type": [ + "integer", + "null" + ], + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": [ + "integer", + "null" + ], + "examples": [ + 8 + ] + }, + "billing_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "org@example.com" + ] + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": [ + "string", + "null" + ] + }, + "members_can_create_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "two_factor_requirement_enabled": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "members_allowed_repository_creation_type": { + "type": "string", + "examples": [ + "all" + ] + }, + "members_can_create_public_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_public_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_fork_private_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "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" ] }, - "default_branch": { - "description": "The default branch of the repository.", + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean", - "examples": [ - false + "uid=example,ou=users,dc=github,dc=com" ] - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "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", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", "created_at", - "updated_at" + "updated_at", + "members_count", + "repos_count", + "organization" ] }, "examples": { - "alternative-response-with-repository-permissions": { + "default": { "value": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "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, + "members_count": 3, + "repos_count": 10, + "created_at": "2017-07-14T16:53:42Z", + "updated_at": "2017-08-17T12:37:15Z", + "organization": { + "login": "github", "id": 1, - "node_id": "MDQ6VXNlcjE=", + "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", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "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", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "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": false, - "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, - "maintain": false, - "push": false, - "triage": false, - "pull": true - }, - "role_name": "read", - "allow_rebase_merge": true, - "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://api.github.com/licenses/mit" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + } } } } } } }, - "204": { - "description": "Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header." - }, "404": { - "description": "Not Found if team does not have permission for the repository" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams" - } - }, - "put": { - "summary": "Add or update team repository permissions", - "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", - "tags": [ - "teams" - ], - "operationId": "teams/add-or-update-repo-permissions-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "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": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "permission": { - "type": "string", - "description": "The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository." - } - } - }, - "examples": { - "default": { - "summary": "Adding a team to an organization repository with the write role", - "value": { - "permission": "push" + "description": "Resource not found", + "content": { + "application/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, @@ -178012,79 +170040,16 @@ "subcategory": "teams" } }, - "delete": { - "summary": "Remove a repository from a team", - "description": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", - "tags": [ - "teams" - ], - "operationId": "teams/remove-repo-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "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" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams" - } - } - }, - "/orgs/{org}/teams/{team_slug}/teams": { - "get": { - "summary": "List child teams", - "description": "Lists the child teams of the team specified by `{team_slug}`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`.", + "patch": { + "summary": "Update a team", + "description": "To edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`.", "tags": [ "teams" ], - "operationId": "teams/list-child-in-org", + "operationId": "teams/update-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#list-child-teams" + "url": "https://docs.github.com/rest/teams/teams#update-a-team" }, "parameters": [ { @@ -178104,350 +170069,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": { - "200": { - "description": "if child teams exist", - "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", - "null" - ] - }, - "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", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] - } - }, - "examples": { - "response-if-child-teams-exist": { - "value": [ - { - "id": 2, - "node_id": "MDQ6VGVhbTI=", - "url": "https://api.github.com/teams/2", - "name": "Original Roster", - "slug": "original-roster", - "description": "Started it all.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/2/members{/member}", - "repositories_url": "https://api.github.com/teams/2/repos", - "parent": { - "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" - }, - "html_url": "https://github.com/orgs/rails/teams/core" - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams" - } - } - }, - "/orgs/{org}/{security_product}/{enablement}": { - "post": { - "summary": "Enable or disable a security feature for an organization", - "description": "> [!WARNING]\n> **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/).\n\nEnables or disables the specified security feature for all eligible repositories in an organization. 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 organization owner or be member of a team with the security manager role to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/enable-or-disable-security-product-on-all-org-repos", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "security_product", - "in": "path", - "description": "The security feature to enable or disable.", - "required": true, - "schema": { - "type": "string", - "enum": [ - "dependency_graph", - "dependabot_alerts", - "dependabot_security_updates", - "advanced_security", - "code_scanning_default_setup", - "secret_scanning", - "secret_scanning_push_protection" - ] - } - }, - { - "name": "enablement", - "in": "path", - "description": "The action to take.\n\n`enable_all` means to enable the specified security feature for all repositories in the organization.\n`disable_all` means to disable the specified security feature for all repositories in the organization.", - "required": true, - "schema": { - "type": "string", - "enum": [ - "enable_all", - "disable_all" - ] - } } ], "requestBody": { @@ -178455,89 +170076,77 @@ "content": { "application/json": { "schema": { + "type": "object", "properties": { - "query_suite": { - "description": "CodeQL query suite to be used. If you specify the `query_suite` parameter, the default setup will be configured with this query suite only on all repositories that didn't have default setup already configured. It will not change the query suite on repositories that already have default setup configured.\nIf you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied.", + "name": { + "type": "string", + "description": "The name of the team." + }, + "description": { + "type": "string", + "description": "The description of the team." + }, + "privacy": { + "type": "string", + "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \n**For a parent or child team:** \n * `closed` - visible to all members of this organization.", + "enum": [ + "secret", + "closed" + ] + }, + "notification_setting": { "type": "string", + "description": "The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: \n * `notifications_enabled` - team members receive notifications when the team is @mentioned. \n * `notifications_disabled` - no one receives notifications.", "enum": [ - "default", - "extended" + "notifications_enabled", + "notifications_disabled" ] + }, + "permission": { + "type": "string", + "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.", + "enum": [ + "pull", + "push", + "admin" + ], + "default": "pull" + }, + "parent_team_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of a team to set as the parent team." } } }, "examples": { "default": { - "value": null + "value": { + "name": "new team name", + "description": "new team description", + "privacy": "closed", + "notification_setting": "notifications_enabled" + } } } } } }, - "responses": { - "204": { - "description": "Action started" - }, - "422": { - "description": "The action could not be taken due to an in progress enablement, or a policy is preventing enablement" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [], - "category": "orgs", - "subcategory": "orgs", - "deprecationDate": "2024-07-22", - "removalDate": "2025-07-22" - }, - "deprecated": true - } - }, - "/projects/columns/cards/{card_id}": { - "get": { - "summary": "Get a project card", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/get-card", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/cards#get-a-project-card" - }, - "parameters": [ - { - "name": "card_id", - "description": "The unique identifier of the card.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], "responses": { "200": { - "description": "Response", + "description": "Response when the updated information already exists", "content": { "application/json": { "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", + "title": "Full Team", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/cards/1478" - ] - }, "id": { - "description": "The project card's ID", + "description": "Unique identifier of the team", "type": "integer", - "format": "int64", "examples": [ 42 ] @@ -178545,515 +170154,101 @@ "node_id": { "type": "string", "examples": [ - "MDExOlByb2plY3RDYXJkMTQ3OA==" - ] - }, - "note": { - "type": [ - "string", - "null" - ], - "examples": [ - "Add payload for delete Project column" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "MDQ6VGVhbTE=" ] }, - "created_at": { + "url": { + "description": "URL for the team", "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2016-09-05T14:21:06Z" + "https://api.github.com/organizations/1/team/1" ] }, - "updated_at": { + "html_url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2016-09-05T14:20:22Z" + "https://github.com/orgs/rails/teams/core" ] }, - "archived": { - "description": "Whether or not the card is archived", - "type": "boolean", + "name": { + "description": "Name of the team", + "type": "string", "examples": [ - false + "Developers" ] }, - "column_name": { - "type": "string" - }, - "project_id": { - "type": "string" - }, - "column_url": { + "slug": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/projects/columns/367" + "justice-league" ] }, - "content_url": { - "type": "string", - "format": "uri", + "description": { + "type": [ + "string", + "null" + ], "examples": [ - "https://api.github.com/repos/api-playground/projects-test/issues/3" + "A great team." ] }, - "project_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", - "format": "uri", + "enum": [ + "closed", + "secret" + ], "examples": [ - "https://api.github.com/projects/120" + "closed" ] - } - }, - "required": [ - "id", - "node_id", - "note", - "url", - "column_url", - "project_url", - "creator", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", - "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 - }, - "created_at": "2016-09-05T14:21:06Z", - "updated_at": "2016-09-05T14:20:22Z", - "archived": false, - "column_url": "https://api.github.com/projects/columns/367", - "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", - "project_url": "https://api.github.com/projects/120" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "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" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/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": "projects-classic", - "subcategory": "cards", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "patch": { - "summary": "Update an existing project card", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/update-card", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/cards#update-an-existing-project-card" - }, - "parameters": [ - { - "name": "card_id", - "description": "The unique identifier of the card.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "note": { - "description": "The project card's note", - "type": [ - "string", - "null" - ], - "examples": [ - "Update all gems" - ] - }, - "archived": { - "description": "Whether or not the card is archived", - "type": "boolean", - "examples": [ - false - ] - } - } - }, - "examples": { - "default": { - "summary": "Change the note on the card", - "value": { - "note": "Add payload for delete Project column" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", - "type": "object", - "properties": { - "url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], "examples": [ - "https://api.github.com/projects/columns/cards/1478" + "notifications_enabled" ] }, - "id": { - "description": "The project card's ID", - "type": "integer", - "format": "int64", + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", "examples": [ - 42 + "push" ] }, - "node_id": { + "members_url": { "type": "string", "examples": [ - "MDExOlByb2plY3RDYXJkMTQ3OA==" + "https://api.github.com/organizations/1/team/1/members{/member}" ] }, - "note": { - "type": [ - "string", - "null" - ], + "repositories_url": { + "type": "string", + "format": "uri", "examples": [ - "Add payload for delete Project column" + "https://api.github.com/organizations/1/team/1/repos" ] }, - "creator": { + "parent": { "anyOf": [ { "type": "null" }, { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { + "description": "Unique identifier of the team", "type": "integer", - "format": "int64", "examples": [ 1 ] @@ -179061,596 +170256,1290 @@ "node_id": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "MDQ6VGVhbTE=" ] }, "url": { + "description": "URL for the team", "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" + "https://api.github.com/organizations/1/team/1" ] }, - "followers_url": { + "members_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "https://api.github.com/organizations/1/team/1/members{/member}" ] }, - "following_url": { + "name": { + "description": "Name of the team", "type": "string", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "Justice League" ] }, - "gists_url": { - "type": "string", + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "A great team." ] }, - "starred_url": { + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "admin" ] }, - "subscriptions_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "closed" ] }, - "organizations_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "notifications_enabled" ] }, - "repos_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "https://github.com/orgs/rails/teams/core" ] }, - "received_events_url": { + "repositories_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" + "https://api.github.com/organizations/1/team/1/repos" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { + "slug": { "type": "string", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "justice-league" ] }, - "user_view_type": { + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ - "public" + "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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" ] } ] }, - "created_at": { - "type": "string", - "format": "date-time", + "members_count": { + "type": "integer", "examples": [ - "2016-09-05T14:21:06Z" + 3 ] }, - "updated_at": { - "type": "string", - "format": "date-time", + "repos_count": { + "type": "integer", "examples": [ - "2016-09-05T14:20:22Z" + 10 ] }, - "archived": { - "description": "Whether or not the card is archived", - "type": "boolean", + "created_at": { + "type": "string", + "format": "date-time", "examples": [ - false + "2017-07-14T16:53:42Z" ] }, - "column_name": { - "type": "string" - }, - "project_id": { - "type": "string" - }, - "column_url": { + "updated_at": { "type": "string", - "format": "uri", + "format": "date-time", "examples": [ - "https://api.github.com/projects/columns/367" + "2017-08-17T12:37:15Z" ] }, - "content_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test/issues/3" + "organization": { + "title": "Team Organization", + "description": "Team Organization", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + }, + "name": { + "type": "string", + "examples": [ + "github" + ] + }, + "company": { + "type": "string", + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": "string", + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": "string", + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "github" + ] + }, + "is_verified": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_organization_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_repository_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "private_gists": { + "type": [ + "integer", + "null" + ], + "examples": [ + 81 + ] + }, + "disk_usage": { + "type": [ + "integer", + "null" + ], + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": [ + "integer", + "null" + ], + "examples": [ + 8 + ] + }, + "billing_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "org@example.com" + ] + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": [ + "string", + "null" + ] + }, + "members_can_create_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "two_factor_requirement_enabled": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "members_allowed_repository_creation_type": { + "type": "string", + "examples": [ + "all" + ] + }, + "members_can_create_public_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_public_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_fork_private_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "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" ] }, - "project_url": { + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/projects/120" + "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", - "note", "url", - "column_url", - "project_url", - "creator", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", "created_at", - "updated_at" + "updated_at", + "members_count", + "repos_count", + "organization" ] }, "examples": { "default": { "value": { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", - "creator": { - "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, + "members_count": 3, + "repos_count": 10, + "created_at": "2017-07-14T16:53:42Z", + "updated_at": "2017-08-17T12:37:15Z", + "organization": { + "login": "github", "id": 1, - "node_id": "MDQ6VXNlcjE=", + "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", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "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", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "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": "2016-09-05T14:21:06Z", - "updated_at": "2016-09-05T14:20:22Z", - "archived": false, - "column_url": "https://api.github.com/projects/columns/367", - "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", - "project_url": "https://api.github.com/projects/120" + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + } } } } } } }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", + "201": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Full Team", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "message": { - "type": "string" + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 42 + ] }, - "documentation_url": { - "type": "string" + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] }, "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" + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] }, - "documentation_url": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] }, - "url": { - "type": "string" + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Developers" + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] }, - "documentation_url": { - "type": "string" + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] }, - "url": { - "type": "string" + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": [ + "closed", + "secret" + ], + "examples": [ + "closed" + ] }, - "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" + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "examples": [ + "notifications_enabled" + ] }, - "documentation_url": { - "type": "string" + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "push" + ] }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "cards", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Delete a project card", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/delete-card", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/cards#delete-a-project-card" - }, - "parameters": [ - { - "name": "card_id", - "description": "The unique identifier of the card.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] }, - "documentation_url": { - "type": "string" + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] }, - "documentation_url": { - "type": "string" + "members_count": { + "type": "integer", + "examples": [ + 3 + ] }, - "url": { - "type": "string" + "repos_count": { + "type": "integer", + "examples": [ + 10 + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-14T16:53:42Z" + ] }, - "documentation_url": { - "type": "string" + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-08-17T12:37:15Z" + ] }, - "url": { - "type": "string" + "organization": { + "title": "Team Organization", + "description": "Team Organization", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + }, + "name": { + "type": "string", + "examples": [ + "github" + ] + }, + "company": { + "type": "string", + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": "string", + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": "string", + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "github" + ] + }, + "is_verified": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_organization_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_repository_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "private_gists": { + "type": [ + "integer", + "null" + ], + "examples": [ + 81 + ] + }, + "disk_usage": { + "type": [ + "integer", + "null" + ], + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": [ + "integer", + "null" + ], + "examples": [ + 8 + ] + }, + "billing_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "org@example.com" + ] + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": [ + "string", + "null" + ] + }, + "members_can_create_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "two_factor_requirement_enabled": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "members_allowed_repository_creation_type": { + "type": "string", + "examples": [ + "all" + ] + }, + "members_can_create_public_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_public_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_fork_private_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "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" + ] }, - "status": { - "type": "string" + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "cards", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/columns/cards/{card_id}/moves": { - "post": { - "summary": "Move a project card", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/move-card", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/cards#move-a-project-card" - }, - "parameters": [ - { - "name": "card_id", - "description": "The unique identifier of the card.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "position": { - "description": "The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card.", - "type": "string", - "pattern": "^(?:top|bottom|after:\\d+)$", - "examples": [ - "bottom" - ] }, - "column_id": { - "description": "The unique identifier of the column the card should be moved to", - "type": "integer", - "examples": [ - 42 - ] - } - }, - "required": [ - "position" - ], - "type": "object" - }, - "examples": { - "default": { - "summary": "Move the card to the bottom of the column", - "value": { - "column_id": 42, - "position": "bottom" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "additionalProperties": false + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "created_at", + "updated_at", + "members_count", + "repos_count", + "organization" + ] }, "examples": { "default": { - "value": null - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "resource": { - "type": "string" - }, - "field": { - "type": "string" - } - } + "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, + "members_count": 3, + "repos_count": 10, + "created_at": "2017-07-14T16:53:42Z", + "updated_at": "2017-08-17T12:37:15Z", + "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", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "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", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" } } } @@ -179658,8 +171547,8 @@ } } }, - "401": { - "description": "Requires authentication", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -179684,41 +171573,6 @@ } } }, - "503": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - } - } - } - } - } - } - } - } - }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { @@ -179793,138 +171647,6 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "cards", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/columns/{column_id}": { - "get": { - "summary": "Get a project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/get-column", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#get-a-project-column" - }, - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - }, - "cards_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367/cards" - ] - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" - ] - }, - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:18:44Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:22:28Z" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - } - } - } - } - } - }, - "304": { - "description": "Not modified" }, "403": { "description": "Forbidden", @@ -179951,410 +171673,102 @@ } } } - }, - "404": { - "description": "Resource not found", - "content": { - "application/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": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true + "category": "teams", + "subcategory": "teams" + } }, - "patch": { - "summary": "Update an existing project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "delete": { + "summary": "Delete a team", + "description": "To delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`.", "tags": [ - "projects-classic" + "teams" ], - "operationId": "projects-classic/update-column", + "operationId": "teams/delete-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#update-an-existing-project-column" + "url": "https://docs.github.com/rest/teams/teams#delete-a-team" }, "parameters": [ { - "name": "column_id", - "description": "The unique identifier of the column.", + "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": { - "properties": { - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" - ] - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "examples": { - "default": { - "summary": "Rename the project column", - "value": { - "name": "To Do" - } - } - } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" } } - }, + ], "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - }, - "cards_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367/cards" - ] - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" - ] - }, - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:18:44Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:22:28Z" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "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" - } - } - } - } - } + "204": { + "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Delete a project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "category": "teams", + "subcategory": "teams" + } + } + }, + "/orgs/{org}/teams/{team_slug}/discussions": { + "get": { + "summary": "List discussions", + "description": "List all discussions on a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ - "projects-classic" + "teams" ], - "operationId": "projects-classic/delete-column", + "operationId": "teams/list-discussions-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#delete-a-project-column" + "url": "https://docs.github.com/rest/teams/discussions#list-discussions" }, "parameters": [ { - "name": "column_id", - "description": "The unique identifier of the column.", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } - } - ], - "responses": { - "204": { - "description": "Response" }, - "304": { - "description": "Not modified" + { + "name": "team_slug", + "description": "The slug of the team name.", + "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" - } - } - } - } - } - }, - "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": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/columns/{column_id}/cards": { - "get": { - "summary": "List project cards", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/list-cards", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/cards#list-project-cards" - }, - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "archived_state", - "description": "Filters the project cards that are returned by the card's state.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "all", - "archived", - "not_archived" - ], - "default": "not_archived" + { + "name": "direction", + "description": "The direction to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" } }, { @@ -180374,6 +171788,15 @@ "type": "integer", "default": 1 } + }, + { + "name": "pinned", + "in": "query", + "required": false, + "description": "Pinned discussions only filter", + "schema": { + "type": "string" + } } ], "responses": { @@ -180384,41 +171807,11 @@ "schema": { "type": "array", "items": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", + "title": "Team Discussion", + "description": "A team discussion is a persistent record of a free-form conversation within a team.", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/cards/1478" - ] - }, - "id": { - "description": "The project card's ID", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOlByb2plY3RDYXJkMTQ3OA==" - ] - }, - "note": { - "type": [ - "string", - "null" - ], - "examples": [ - "Add payload for delete Project column" - ] - }, - "creator": { + "author": { "anyOf": [ { "type": "null" @@ -180593,65 +171986,183 @@ } ] }, + "body": { + "description": "The main text of the discussion.", + "type": "string", + "examples": [ + "Please suggest improvements to our workflow in comments." + ] + }, + "body_html": { + "type": "string", + "examples": [ + "

Hi! This is an area for us to collaborate as a team

" + ] + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "type": "string", + "examples": [ + "0307116bbf7ced493b8d8a346c650b71" + ] + }, + "comments_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + ] + }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:21:06Z" + "2018-01-25T18:56:31Z" ] }, - "updated_at": { + "last_edited_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2016-09-05T14:20:22Z" + "https://github.com/orgs/github/teams/justice-league/discussions/1" ] }, - "archived": { - "description": "Whether or not the card is archived", - "type": "boolean", + "node_id": { + "type": "string", "examples": [ - false + "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" ] }, - "column_name": { - "type": "string" + "number": { + "description": "The unique sequence number of a team discussion.", + "type": "integer", + "examples": [ + 42 + ] }, - "project_id": { - "type": "string" + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "type": "boolean", + "examples": [ + true + ] }, - "column_url": { + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "type": "boolean", + "examples": [ + true + ] + }, + "team_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/367" + "https://api.github.com/organizations/1/team/2343027" ] }, - "content_url": { + "title": { + "description": "The title of the discussion.", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/repos/api-playground/projects-test/issues/3" + "How can we improve our workflow?" ] }, - "project_url": { + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-01-25T18:56:31Z" + ] + }, + "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/120" + "https://api.github.com/organizations/1/team/2343027/discussions/1" + ] + }, + "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", - "note", - "url", - "column_url", - "project_url", - "creator", + "author", + "body", + "body_html", + "body_version", + "comments_count", + "comments_url", "created_at", - "updated_at" + "last_edited_at", + "html_url", + "pinned", + "private", + "node_id", + "number", + "team_url", + "title", + "updated_at", + "url" ] } }, @@ -180659,11 +172170,7 @@ "default": { "value": [ { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", - "creator": { + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -180683,12 +172190,34 @@ "type": "User", "site_admin": false }, - "created_at": "2016-09-05T14:21:06Z", - "updated_at": "2016-09-05T14:20:22Z", - "archived": false, - "column_url": "https://api.github.com/projects/columns/367", - "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", - "project_url": "https://api.github.com/projects/120" + "body": "Hi! This is an area for us to collaborate as a team.", + "body_html": "

Hi! This is an area for us to collaborate as a team

", + "body_version": "0d495416a700fb06133c612575d92bfb", + "comments_count": 0, + "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", + "created_at": "2018-01-25T18:56:31Z", + "last_edited_at": null, + "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", + "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", + "number": 1, + "pinned": false, + "private": false, + "team_url": "https://api.github.com/teams/2343027", + "title": "Our first team post", + "updated_at": "2018-01-25T18:56:31Z", + "url": "https://api.github.com/teams/2343027/discussions/1", + "reactions": { + "url": "https://api.github.com/teams/2343027/discussions/1/reactions", + "total_count": 5, + "+1": 3, + "-1": 1, + "laugh": 0, + "confused": 0, + "heart": 1, + "hooray": 0, + "eyes": 1, + "rocket": 1 + } } ] } @@ -180703,92 +172232,43 @@ } } } - }, - "304": { - "description": "Not modified" - }, - "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": true, - "category": "projects-classic", - "subcategory": "cards", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true + "category": "teams", + "subcategory": "discussions" + } }, "post": { - "summary": "Create a project card", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "summary": "Create a discussion", + "description": "Creates a new discussion post on a team's page.\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)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ - "projects-classic" + "teams" ], - "operationId": "projects-classic/create-card", + "operationId": "teams/create-discussion-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/cards#create-a-project-card" + "url": "https://docs.github.com/rest/teams/discussions#create-a-discussion" }, "parameters": [ { - "name": "column_id", - "description": "The unique identifier of the column.", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" } } ], @@ -180797,55 +172277,32 @@ "content": { "application/json": { "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "note": { - "description": "The project card's note", - "type": [ - "string", - "null" - ], - "examples": [ - "Update all gems" - ] - } - }, - "required": [ - "note" - ] + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The discussion post's title." }, - { - "type": "object", - "properties": { - "content_id": { - "description": "The unique identifier of the content associated with the card", - "type": "integer", - "examples": [ - 42 - ] - }, - "content_type": { - "description": "The piece of content associated with the card", - "type": "string", - "examples": [ - "PullRequest" - ] - } - }, - "required": [ - "content_id", - "content_type" - ] + "body": { + "type": "string", + "description": "The discussion post's body text." + }, + "private": { + "type": "boolean", + "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.", + "default": false } + }, + "required": [ + "title", + "body" ] }, "examples": { "default": { - "summary": "Create a new card", "value": { - "note": "Add payload for delete Project column" + "title": "Our first team post", + "body": "Hi! This is an area for us to collaborate as a team." } } } @@ -180858,41 +172315,11 @@ "content": { "application/json": { "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", + "title": "Team Discussion", + "description": "A team discussion is a persistent record of a free-form conversation within a team.", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/cards/1478" - ] - }, - "id": { - "description": "The project card's ID", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOlByb2plY3RDYXJkMTQ3OA==" - ] - }, - "note": { - "type": [ - "string", - "null" - ], - "examples": [ - "Add payload for delete Project column" - ] - }, - "creator": { + "author": { "anyOf": [ { "type": "null" @@ -181067,75 +172494,189 @@ } ] }, + "body": { + "description": "The main text of the discussion.", + "type": "string", + "examples": [ + "Please suggest improvements to our workflow in comments." + ] + }, + "body_html": { + "type": "string", + "examples": [ + "

Hi! This is an area for us to collaborate as a team

" + ] + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "type": "string", + "examples": [ + "0307116bbf7ced493b8d8a346c650b71" + ] + }, + "comments_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + ] + }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:21:06Z" + "2018-01-25T18:56:31Z" ] }, - "updated_at": { + "last_edited_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2016-09-05T14:20:22Z" + "https://github.com/orgs/github/teams/justice-league/discussions/1" ] }, - "archived": { - "description": "Whether or not the card is archived", - "type": "boolean", + "node_id": { + "type": "string", "examples": [ - false + "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" ] }, - "column_name": { - "type": "string" + "number": { + "description": "The unique sequence number of a team discussion.", + "type": "integer", + "examples": [ + 42 + ] }, - "project_id": { - "type": "string" + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "type": "boolean", + "examples": [ + true + ] }, - "column_url": { + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "type": "boolean", + "examples": [ + true + ] + }, + "team_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/367" + "https://api.github.com/organizations/1/team/2343027" ] }, - "content_url": { + "title": { + "description": "The title of the discussion.", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/repos/api-playground/projects-test/issues/3" + "How can we improve our workflow?" ] }, - "project_url": { + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-01-25T18:56:31Z" + ] + }, + "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/120" + "https://api.github.com/organizations/1/team/2343027/discussions/1" + ] + }, + "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", - "note", - "url", - "column_url", - "project_url", - "creator", + "author", + "body", + "body_html", + "body_version", + "comments_count", + "comments_url", "created_at", - "updated_at" + "last_edited_at", + "html_url", + "pinned", + "private", + "node_id", + "number", + "team_url", + "title", + "updated_at", + "url" ] }, "examples": { "default": { "value": { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", - "creator": { + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -181155,203 +172696,33 @@ "type": "User", "site_admin": false }, - "created_at": "2016-09-05T14:21:06Z", - "updated_at": "2016-09-05T14:20:22Z", - "archived": false, - "column_url": "https://api.github.com/projects/columns/367", - "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", - "project_url": "https://api.github.com/projects/120" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "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" - } - } - } - } - } - }, - "422": { - "description": "Validation failed", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - }, - { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - ] - } - } - } - }, - "503": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - } - } + "body": "Hi! This is an area for us to collaborate as a team.", + "body_html": "

Hi! This is an area for us to collaborate as a team

", + "body_version": "0d495416a700fb06133c612575d92bfb", + "comments_count": 0, + "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", + "created_at": "2018-01-25T18:56:31Z", + "last_edited_at": null, + "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", + "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", + "number": 1, + "pinned": false, + "private": false, + "team_url": "https://api.github.com/teams/2343027", + "title": "Our first team post", + "updated_at": "2018-01-25T18:56:31Z", + "url": "https://api.github.com/teams/2343027/discussions/1", + "reactions": { + "url": "https://api.github.com/teams/2343027/discussions/1/reactions", + "total_count": 5, + "+1": 3, + "-1": 1, + "laugh": 0, + "confused": 0, + "heart": 1, + "hooray": 0, + "eyes": 1, + "rocket": 1 } } } @@ -181361,201 +172732,48 @@ } }, "x-github": { + "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "cards", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true + "category": "teams", + "subcategory": "discussions" + } } }, - "/projects/columns/{column_id}/moves": { - "post": { - "summary": "Move a project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": { + "get": { + "summary": "Get a discussion", + "description": "Get a specific discussion on a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ - "projects-classic" + "teams" ], - "operationId": "projects-classic/move-column", + "operationId": "teams/get-discussion-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#move-a-project-column" + "url": "https://docs.github.com/rest/teams/discussions#get-a-discussion" }, "parameters": [ { - "name": "column_id", - "description": "The unique identifier of the column.", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "position": { - "description": "The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column.", - "type": "string", - "pattern": "^(?:first|last|after:\\d+)$", - "examples": [ - "last" - ] - } - }, - "required": [ - "position" - ], - "type": "object" - }, - "examples": { - "default": { - "summary": "Move the column to the end of the board", - "value": { - "position": "last" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "additionalProperties": false - }, - "examples": { - "default": { - "value": null - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "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" - } - } - } - } + "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" - } - } - } - } - } + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "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": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}": { - "get": { - "summary": "Get a project", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/get", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#get-a-project" - }, - "parameters": [ { - "name": "project_id", - "description": "The unique identifier of the project.", + "name": "discussion_number", + "description": "The number that identifies the discussion.", "in": "path", "required": true, "schema": { @@ -181569,81 +172787,11 @@ "content": { "application/json": { "schema": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", + "title": "Team Discussion", + "description": "A team discussion is a persistent record of a free-form conversation within a team.", "type": "object", "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "creator": { + "author": { "anyOf": [ { "type": "null" @@ -181818,65 +172966,189 @@ } ] }, + "body": { + "description": "The main text of the discussion.", + "type": "string", + "examples": [ + "Please suggest improvements to our workflow in comments." + ] + }, + "body_html": { + "type": "string", + "examples": [ + "

Hi! This is an area for us to collaborate as a team

" + ] + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "type": "string", + "examples": [ + "0307116bbf7ced493b8d8a346c650b71" + ] + }, + "comments_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + ] + }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2011-04-10T20:09:31Z" + "2018-01-25T18:56:31Z" + ] + }, + "last_edited_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/github/teams/justice-league/discussions/1" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" + ] + }, + "number": { + "description": "The unique sequence number of a team discussion.", + "type": "integer", + "examples": [ + 42 + ] + }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "type": "boolean", + "examples": [ + true + ] + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "type": "boolean", + "examples": [ + true + ] + }, + "team_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027" + ] + }, + "title": { + "description": "The title of the discussion.", + "type": "string", + "examples": [ + "How can we improve our workflow?" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2014-03-03T18:58:10Z" + "2018-01-25T18:56:31Z" ] }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "url": { "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027/discussions/1" ] }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" + "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", - "number", - "name", + "author", "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", + "body_html", + "body_version", + "comments_count", + "comments_url", "created_at", - "updated_at" + "last_edited_at", + "html_url", + "pinned", + "private", + "node_id", + "number", + "team_url", + "title", + "updated_at", + "url" ] }, "examples": { "default": { "value": { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "number": 1, - "state": "open", - "creator": { + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -181896,63 +173168,34 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "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" + "body": "Hi! This is an area for us to collaborate as a team.", + "body_html": "

Hi! This is an area for us to collaborate as a team

", + "body_version": "0d495416a700fb06133c612575d92bfb", + "comments_count": 0, + "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", + "created_at": "2018-01-25T18:56:31Z", + "last_edited_at": null, + "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", + "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", + "number": 1, + "pinned": false, + "private": false, + "team_url": "https://api.github.com/teams/2343027", + "title": "Our first team post", + "updated_at": "2018-01-25T18:56:31Z", + "url": "https://api.github.com/teams/2343027/discussions/1", + "reactions": { + "url": "https://api.github.com/teams/2343027/discussions/1/reactions", + "total_count": 5, + "+1": 3, + "-1": 1, + "laugh": 0, + "confused": 0, + "heart": 1, + "hooray": 0, + "eyes": 1, + "rocket": 1 + } } } } @@ -181963,28 +173206,43 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true + "category": "teams", + "subcategory": "discussions" + } }, "patch": { - "summary": "Update a project", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "operationId": "projects-classic/update", + "summary": "Update a discussion", + "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ - "projects-classic" + "teams" ], + "operationId": "teams/update-discussion-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#update-a-project" + "url": "https://docs.github.com/rest/teams/discussions#update-a-discussion" }, "parameters": [ { - "name": "project_id", - "description": "The unique identifier of the project.", + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discussion_number", + "description": "The number that identifies the discussion.", "in": "path", "required": true, "schema": { @@ -181997,55 +173255,22 @@ "content": { "application/json": { "schema": { + "type": "object", "properties": { - "name": { - "description": "Name of the project", + "title": { "type": "string", - "examples": [ - "Week One Sprint" - ] + "description": "The discussion post's title." }, "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project", "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone.", - "type": "boolean" + "description": "The discussion post's body text." } - }, - "type": "object" + } }, "examples": { "default": { - "summary": "Change the name, state, and permissions for a project", "value": { - "name": "Week One Sprint", - "state": "open", - "organization_permission": "write" + "title": "Welcome to our first team post" } } } @@ -182058,81 +173283,11 @@ "content": { "application/json": { "schema": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", + "title": "Team Discussion", + "description": "A team discussion is a persistent record of a free-form conversation within a team.", "type": "object", "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "creator": { + "author": { "anyOf": [ { "type": "null" @@ -182307,65 +173462,189 @@ } ] }, + "body": { + "description": "The main text of the discussion.", + "type": "string", + "examples": [ + "Please suggest improvements to our workflow in comments." + ] + }, + "body_html": { + "type": "string", + "examples": [ + "

Hi! This is an area for us to collaborate as a team

" + ] + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "type": "string", + "examples": [ + "0307116bbf7ced493b8d8a346c650b71" + ] + }, + "comments_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + ] + }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2011-04-10T20:09:31Z" + "2018-01-25T18:56:31Z" + ] + }, + "last_edited_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/github/teams/justice-league/discussions/1" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" + ] + }, + "number": { + "description": "The unique sequence number of a team discussion.", + "type": "integer", + "examples": [ + 42 + ] + }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "type": "boolean", + "examples": [ + true + ] + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "type": "boolean", + "examples": [ + true + ] + }, + "team_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027" + ] + }, + "title": { + "description": "The title of the discussion.", + "type": "string", + "examples": [ + "How can we improve our workflow?" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2014-03-03T18:58:10Z" + "2018-01-25T18:56:31Z" ] }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "url": { "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027/discussions/1" ] }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" + "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", - "number", - "name", + "author", "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", + "body_html", + "body_version", + "comments_count", + "comments_url", "created_at", - "updated_at" + "last_edited_at", + "html_url", + "pinned", + "private", + "node_id", + "number", + "team_url", + "title", + "updated_at", + "url" ] }, "examples": { "default": { "value": { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "number": 1, - "state": "open", - "creator": { + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -182385,119 +173664,33 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - } - } - } - } - } - }, - "404": { - "description": "Not Found if the authenticated user does not have access to the project" - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "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" - } - } - } - } - } - }, - "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 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" + "body": "Hi! This is an area for us to collaborate as a team.", + "body_html": "

Hi! This is an area for us to collaborate as a team

", + "body_version": "0d495416a700fb06133c612575d92bfb", + "comments_count": 1, + "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", + "created_at": "2018-01-25T18:56:31Z", + "last_edited_at": "2018-01-26T18:22:20Z", + "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", + "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", + "number": 1, + "pinned": false, + "private": false, + "team_url": "https://api.github.com/teams/2343027", + "title": "Welcome to our first team post", + "updated_at": "2018-01-26T18:22:20Z", + "url": "https://api.github.com/teams/2343027/discussions/1", + "reactions": { + "url": "https://api.github.com/teams/2343027/discussions/1/reactions", + "total_count": 5, + "+1": 3, + "-1": 1, + "laugh": 0, + "confused": 0, + "heart": 1, + "hooray": 0, + "eyes": 1, + "rocket": 1 } } } @@ -182509,28 +173702,43 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true + "category": "teams", + "subcategory": "discussions" + } }, "delete": { - "summary": "Delete a project", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "operationId": "projects-classic/delete", + "summary": "Delete a discussion", + "description": "Delete a discussion from a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ - "projects-classic" + "teams" ], + "operationId": "teams/delete-discussion-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#delete-a-project" + "url": "https://docs.github.com/rest/teams/discussions#delete-a-discussion" }, "parameters": [ { - "name": "project_id", - "description": "The unique identifier of the project.", + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discussion_number", + "description": "The number that identifies the discussion.", "in": "path", "required": true, "schema": { @@ -182540,141 +173748,51 @@ ], "responses": { "204": { - "description": "Delete Success" + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "discussions" + } + } + }, + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": { + "get": { + "summary": "List discussion comments", + "description": "List all comments on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "tags": [ + "teams" + ], + "operationId": "teams/list-discussion-comments-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "304": { - "description": "Not modified" + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "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" - } - } - } - } - } - }, - "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" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/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": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}/collaborators": { - "get": { - "summary": "List project collaborators", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/list-collaborators", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#list-project-collaborators" - }, - "parameters": [ { - "name": "project_id", - "description": "The unique identifier of the project.", + "name": "discussion_number", + "description": "The number that identifies the discussion.", "in": "path", "required": true, "schema": { @@ -182682,18 +173800,17 @@ } }, { - "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 organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see.", + "name": "direction", + "description": "The direction to sort the results by.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ - "outside", - "direct", - "all" + "asc", + "desc" ], - "default": "all" + "default": "desc" } }, { @@ -182723,170 +173840,322 @@ "schema": { "type": "array", "items": { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Team Discussion Comment", + "description": "A reply to a discussion within a team.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } ] }, - "login": { + "body": { + "description": "The main text of the comment.", "type": "string", "examples": [ - "octocat" + "I agree with this suggestion." ] }, - "id": { - "type": "integer", - "format": "int64", + "body_html": { + "type": "string", "examples": [ - 1 + "

Do you like apples?

" ] }, - "node_id": { + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "0307116bbf7ced493b8d8a346c650b71" ] }, - "avatar_url": { + "created_at": { "type": "string", - "format": "uri", + "format": "date-time", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "2018-01-15T23:53:58Z" ] }, - "gravatar_id": { + "last_edited_at": { "type": [ "string", "null" ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] + "format": "date-time" }, - "url": { + "discussion_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "https://api.github.com/organizations/1/team/2403582/discussions/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" ] }, - "organizations_url": { + "node_id": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" ] }, - "repos_url": { - "type": "string", - "format": "uri", + "number": { + "description": "The unique sequence number of a team discussion comment.", + "type": "integer", "examples": [ - "https://api.github.com/users/octocat/repos" + 42 ] }, - "events_url": { + "updated_at": { "type": "string", + "format": "date-time", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "2018-01-15T23:53:58Z" ] }, - "received_events_url": { + "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" + "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" ] }, - "user_view_type": { - "type": "string", - "examples": [ - "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", + "author", + "body", + "body_html", + "body_version", + "created_at", + "last_edited_at", + "discussion_url", "html_url", - "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", + "number", + "updated_at", "url" ] } @@ -182895,24 +174164,49 @@ "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 + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Do you like apples?", + "body_html": "

Do you like apples?

", + "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51", + "created_at": "2018-01-15T23:53:58Z", + "last_edited_at": null, + "discussion_url": "https://api.github.com/teams/2403582/discussions/1", + "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", + "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", + "number": 1, + "updated_at": "2018-01-15T23:53:58Z", + "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", + "reactions": { + "url": "https://api.github.com/teams/2403582/discussions/1/reactions", + "total_count": 5, + "+1": 3, + "-1": 1, + "laugh": 0, + "confused": 0, + "heart": 1, + "hooray": 0, + "eyes": 1, + "rocket": 1 + } } ] } @@ -182927,237 +174221,75 @@ } } } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "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": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}/collaborators/{username}": { - "put": { - "summary": "Add project collaborator", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "category": "teams", + "subcategory": "discussion-comments" + } + }, + "post": { + "summary": "Create a discussion comment", + "description": "Creates a new comment on a team discussion.\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)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ - "projects-classic" + "teams" ], - "operationId": "projects-classic/add-collaborator", + "operationId": "teams/create-discussion-comment-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#add-project-collaborator" + "url": "https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment" }, "parameters": [ { - "name": "project_id", - "description": "The unique identifier of the project.", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } }, { - "name": "username", - "description": "The handle for the GitHub user account.", + "name": "team_slug", + "description": "The slug of the team name.", "in": "path", "required": true, "schema": { "type": "string" } + }, + { + "name": "discussion_number", + "description": "The number that identifies the discussion.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { - "type": [ - "object", - "null" - ], + "type": "object", "properties": { - "permission": { - "description": "The permission to grant the collaborator.", - "enum": [ - "read", - "write", - "admin" - ], - "default": "write", + "body": { "type": "string", - "examples": [ - "write" - ] + "description": "The discussion comment's body text." } - } + }, + "required": [ + "body" + ] }, "examples": { "default": { - "summary": "Applying write permissions for the new collaborator", "value": { - "permission": "write" + "body": "Do you like apples?" } } } @@ -183165,159 +174297,376 @@ } }, "responses": { - "204": { - "description": "Response" - }, - "404": { - "description": "Resource not found", + "201": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Team Discussion Comment", + "description": "A reply to a discussion within a team.", "type": "object", "properties": { - "message": { - "type": "string" + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] }, - "documentation_url": { - "type": "string" + "body": { + "description": "The main text of the comment.", + "type": "string", + "examples": [ + "I agree with this suggestion." + ] }, - "url": { - "type": "string" + "body_html": { + "type": "string", + "examples": [ + "

Do you like apples?

" + ] }, - "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" + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "type": "string", + "examples": [ + "0307116bbf7ced493b8d8a346c650b71" + ] }, - "documentation_url": { - "type": "string" + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-01-15T23:53:58Z" + ] }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "last_edited_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - "documentation_url": { - "type": "string" + "discussion_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1" + ] }, - "url": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "node_id": { + "type": "string", + "examples": [ + "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + ] }, - "documentation_url": { - "type": "string" + "number": { + "description": "The unique sequence number of a team discussion comment.", + "type": "integer", + "examples": [ + 42 + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-01-15T23:53:58Z" + ] }, "url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + ] }, - "status": { - "type": "string" + "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": [ + "author", + "body", + "body_html", + "body_version", + "created_at", + "last_edited_at", + "discussion_url", + "html_url", + "node_id", + "number", + "updated_at", + "url" + ] + }, + "examples": { + "default": { + "value": { + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Do you like apples?", + "body_html": "

Do you like apples?

", + "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51", + "created_at": "2018-01-15T23:53:58Z", + "last_edited_at": null, + "discussion_url": "https://api.github.com/teams/2403582/discussions/1", + "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", + "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", + "number": 1, + "updated_at": "2018-01-15T23:53:58Z", + "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", + "reactions": { + "url": "https://api.github.com/teams/2403582/discussions/1/reactions", + "total_count": 5, + "+1": 3, + "-1": 1, + "laugh": 0, + "confused": 0, + "heart": 1, + "hooray": 0, + "eyes": 1, + "rocket": 1 + } } } } @@ -183326,234 +174675,48 @@ } }, "x-github": { + "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Remove user as a collaborator", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "category": "teams", + "subcategory": "discussion-comments" + } + } + }, + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": { + "get": { + "summary": "Get a discussion comment", + "description": "Get a specific comment on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ - "projects-classic" + "teams" ], - "operationId": "projects-classic/remove-collaborator", + "operationId": "teams/get-discussion-comment-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#remove-user-as-a-collaborator" + "url": "https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment" }, "parameters": [ { - "name": "project_id", - "description": "The unique identifier of the project.", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } }, { - "name": "username", - "description": "The handle for the GitHub user account.", + "name": "team_slug", + "description": "The slug of the team name.", "in": "path", "required": true, "schema": { "type": "string" } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "304": { - "description": "Not modified" - }, - "404": { - "description": "Resource not found", - "content": { - "application/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" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } }, - "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": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}/collaborators/{username}/permission": { - "get": { - "summary": "Get project permission for a user", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/get-permission-for-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#get-project-permission-for-a-user" - }, - "parameters": [ { - "name": "project_id", - "description": "The unique identifier of the project.", + "name": "discussion_number", + "description": "The number that identifies the discussion.", "in": "path", "required": true, "schema": { @@ -183561,12 +174724,12 @@ } }, { - "name": "username", - "description": "The handle for the GitHub user account.", + "name": "comment_number", + "description": "The number that identifies the comment.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], @@ -183576,14 +174739,11 @@ "content": { "application/json": { "schema": { - "title": "Project Collaborator Permission", - "description": "Project Collaborator Permission", + "title": "Team Discussion Comment", + "description": "A reply to a discussion within a team.", "type": "object", "properties": { - "permission": { - "type": "string" - }, - "user": { + "author": { "anyOf": [ { "type": "null" @@ -183757,18 +174917,151 @@ ] } ] + }, + "body": { + "description": "The main text of the comment.", + "type": "string", + "examples": [ + "I agree with this suggestion." + ] + }, + "body_html": { + "type": "string", + "examples": [ + "

Do you like apples?

" + ] + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "type": "string", + "examples": [ + "0307116bbf7ced493b8d8a346c650b71" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-01-15T23:53:58Z" + ] + }, + "last_edited_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "discussion_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + ] + }, + "number": { + "description": "The unique sequence number of a team discussion comment.", + "type": "integer", + "examples": [ + 42 + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-01-15T23:53:58Z" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + ] + }, + "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": [ - "permission", - "user" + "author", + "body", + "body_html", + "body_version", + "created_at", + "last_edited_at", + "discussion_url", + "html_url", + "node_id", + "number", + "updated_at", + "url" ] }, "examples": { "default": { "value": { - "permission": "admin", - "user": { + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -183787,410 +175080,979 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false + }, + "body": "Do you like apples?", + "body_html": "

Do you like apples?

", + "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51", + "created_at": "2018-01-15T23:53:58Z", + "last_edited_at": null, + "discussion_url": "https://api.github.com/teams/2403582/discussions/1", + "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", + "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", + "number": 1, + "updated_at": "2018-01-15T23:53:58Z", + "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", + "reactions": { + "url": "https://api.github.com/teams/2403582/discussions/1/reactions", + "total_count": 5, + "+1": 3, + "-1": 1, + "laugh": 0, + "confused": 0, + "heart": 1, + "hooray": 0, + "eyes": 1, + "rocket": 1 } } } } } } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "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": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}/columns": { - "get": { - "summary": "List project columns", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "category": "teams", + "subcategory": "discussion-comments" + } + }, + "patch": { + "summary": "Update a discussion comment", + "description": "Edits the body text of a discussion comment.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ - "projects-classic" + "teams" ], - "operationId": "projects-classic/list-columns", + "operationId": "teams/update-discussion-comment-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#list-project-columns" + "url": "https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment" }, "parameters": [ { - "name": "project_id", - "description": "The unique identifier of the project.", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" + "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", + "name": "team_slug", + "description": "The slug of the team name.", + "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": "discussion_number", + "description": "The number that identifies the discussion.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" + } + }, + { + "name": "comment_number", + "description": "The number that identifies the comment.", + "in": "path", + "required": true, + "schema": { + "type": "integer" } } ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - }, - "cards_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367/cards" - ] - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" - ] - }, - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:18:44Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:22:28Z" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "created_at", - "updated_at" - ] + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "type": "string", + "description": "The discussion comment's body text." } }, - "examples": { - "default": { - "value": [ - { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - } - ] + "required": [ + "body" + ] + }, + "examples": { + "default": { + "value": { + "body": "Do you like pineapples?" } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", + } + }, + "responses": { + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Team Discussion Comment", + "description": "A reply to a discussion within a team.", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "body": { + "description": "The main text of the comment.", + "type": "string", + "examples": [ + "I agree with this suggestion." + ] + }, + "body_html": { + "type": "string", + "examples": [ + "

Do you like apples?

" + ] + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "type": "string", + "examples": [ + "0307116bbf7ced493b8d8a346c650b71" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-01-15T23:53:58Z" + ] + }, + "last_edited_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "discussion_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + ] + }, + "number": { + "description": "The unique sequence number of a team discussion comment.", + "type": "integer", + "examples": [ + 42 + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-01-15T23:53:58Z" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + ] + }, + "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": [ + "author", + "body", + "body_html", + "body_version", + "created_at", + "last_edited_at", + "discussion_url", + "html_url", + "node_id", + "number", + "updated_at", + "url" + ] + }, + "examples": { + "default": { + "value": { + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Do you like pineapples?", + "body_html": "

Do you like pineapples?

", + "body_version": "e6907b24d9c93cc0c5024a7af5888116", + "created_at": "2018-01-15T23:53:58Z", + "last_edited_at": "2018-01-26T18:22:20Z", + "discussion_url": "https://api.github.com/teams/2403582/discussions/1", + "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", + "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", + "number": 1, + "updated_at": "2018-01-26T18:22:20Z", + "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", + "reactions": { + "url": "https://api.github.com/teams/2403582/discussions/1/reactions", + "total_count": 5, + "+1": 3, + "-1": 1, + "laugh": 0, + "confused": 0, + "heart": 1, + "hooray": 0, + "eyes": 1, + "rocket": 1 + } } } } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "discussion-comments" + } + }, + "delete": { + "summary": "Delete a discussion comment", + "description": "Deletes a comment on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "tags": [ + "teams" + ], + "operationId": "teams/delete-discussion-comment-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment" + }, + "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": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discussion_number", + "description": "The number that identifies the discussion.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "comment_number", + "description": "The number that identifies the comment.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "discussion-comments" + } + } + }, + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { + "get": { + "summary": "List reactions for a team discussion comment", + "description": "List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "tags": [ + "reactions" + ], + "operationId": "reactions/list-for-team-discussion-comment-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discussion_number", + "description": "The number that identifies the discussion.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "comment_number", + "description": "The number that identifies the comment.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "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.", + "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": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDg6UmVhY3Rpb24x" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "content": { + "description": "The reaction to use", + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "examples": [ + "heart" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-05-20T20:09:31Z" + ] + } }, - "status": { - "type": "string" - } + "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" + } + } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true + "category": "reactions", + "subcategory": "reactions" + } }, "post": { - "summary": "Create a project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "summary": "Create reaction for a team discussion comment", + "description": "Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ - "projects-classic" + "reactions" ], - "operationId": "projects-classic/create-column", + "operationId": "reactions/create-for-team-discussion-comment-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#create-a-project-column" + "url": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment" }, "parameters": [ { - "name": "project_id", - "description": "The unique identifier of the project.", + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discussion_number", + "description": "The number that identifies the discussion.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "comment_number", + "description": "The number that identifies the comment.", "in": "path", "required": true, "schema": { @@ -184203,24 +176065,31 @@ "content": { "application/json": { "schema": { + "type": "object", "properties": { - "name": { - "description": "Name of the project column", + "content": { "type": "string", - "examples": [ - "Remaining tasks" + "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" ] } }, "required": [ - "name" - ], - "type": "object" + "content" + ] }, "examples": { "default": { "value": { - "name": "Remaining tasks" + "content": "heart" } } } @@ -184228,704 +176097,627 @@ } }, "responses": { - "201": { - "description": "Response", + "200": { + "description": "Response when the reaction type has already been added to this team discussion comment", "content": { "application/json": { "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", + "title": "Reaction", + "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - }, - "cards_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367/cards" - ] - }, "id": { - "description": "The unique identifier of the project column", "type": "integer", "examples": [ - 42 + 1 ] }, "node_id": { "type": "string", "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" + "MDg6UmVhY3Rpb24x" ] }, - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } ] }, - "created_at": { + "content": { + "description": "The reaction to use", "type": "string", - "format": "date-time", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], "examples": [ - "2016-09-05T14:18:44Z" + "heart" ] }, - "updated_at": { + "created_at": { "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:22:28Z" + "2016-05-20T20:09:31Z" ] } }, "required": [ "id", "node_id", - "url", - "project_url", - "cards_url", - "name", - "created_at", - "updated_at" + "user", + "content", + "created_at" ] }, "examples": { "default": { "value": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "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" - } - } - } - } - } - }, - "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": 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" } } } } } }, - "401": { - "description": "Requires authentication", + "201": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Reaction", + "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + "id": { + "type": "integer", + "examples": [ + 1 + ] }, - "url": { - "type": "string" + "node_id": { + "type": "string", + "examples": [ + "MDg6UmVhY3Rpb24x" + ] }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/rate_limit": { - "get": { - "summary": "Get rate limit status for the authenticated user", - "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners).\"\n* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", - "tags": [ - "rate-limit" - ], - "operationId": "rate-limit/get", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user" - }, - "parameters": [], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Rate Limit Overview", - "description": "Rate Limit Overview", - "type": "object", - "properties": { - "resources": { - "type": "object", - "properties": { - "core": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "graphql": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "search": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "code_search": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "source_import": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] + "user": { + "anyOf": [ + { + "type": "null" }, - "integration_manifest": { - "title": "Rate Limit", + { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "limit": { - "type": "integer" + "name": { + "type": [ + "string", + "null" + ] }, - "remaining": { - "type": "integer" + "email": { + "type": [ + "string", + "null" + ] }, - "reset": { - "type": "integer" + "login": { + "type": "string", + "examples": [ + "octocat" + ] }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "code_scanning_upload": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] }, - "remaining": { - "type": "integer" + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] }, - "reset": { - "type": "integer" + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "actions_runner_registration": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] }, - "remaining": { - "type": "integer" + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] }, - "reset": { - "type": "integer" + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "scim": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] }, - "remaining": { - "type": "integer" + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] }, - "reset": { - "type": "integer" + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "dependency_snapshots": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] }, - "remaining": { - "type": "integer" + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] }, - "reset": { - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "dependency_sbom": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] }, - "remaining": { - "type": "integer" + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] }, - "reset": { - "type": "integer" + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "code_scanning_autofix": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "type": { + "type": "string", + "examples": [ + "User" + ] }, - "remaining": { - "type": "integer" + "site_admin": { + "type": "boolean" }, - "reset": { - "type": "integer" + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] }, - "used": { - "type": "integer" + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } }, "required": [ - "limit", - "remaining", - "reset", - "used" + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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": [ - "core", - "search" ] }, - "rate": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" + "content": { + "description": "The reaction to use", + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "examples": [ + "heart" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-05-20T20:09:31Z" ] } }, "required": [ - "rate", - "resources" + "id", + "node_id", + "user", + "content", + "created_at" ] }, "examples": { "default": { "value": { - "resources": { - "core": { - "limit": 5000, - "used": 1, - "remaining": 4999, - "reset": 1691591363 - }, - "search": { - "limit": 30, - "used": 12, - "remaining": 18, - "reset": 1691591091 - }, - "graphql": { - "limit": 5000, - "used": 7, - "remaining": 4993, - "reset": 1691593228 - }, - "integration_manifest": { - "limit": 5000, - "used": 1, - "remaining": 4999, - "reset": 1691594631 - }, - "source_import": { - "limit": 100, - "used": 1, - "remaining": 99, - "reset": 1691591091 - }, - "code_scanning_upload": { - "limit": 500, - "used": 1, - "remaining": 499, - "reset": 1691594631 - }, - "actions_runner_registration": { - "limit": 10000, - "used": 0, - "remaining": 10000, - "reset": 1691594631 - }, - "scim": { - "limit": 15000, - "used": 0, - "remaining": 15000, - "reset": 1691594631 - }, - "dependency_snapshots": { - "limit": 100, - "used": 0, - "remaining": 100, - "reset": 1691591091 - }, - "code_search": { - "limit": 10, - "used": 0, - "remaining": 10, - "reset": 1691591091 - }, - "code_scanning_autofix": { - "limit": 10, - "used": 0, - "remaining": 10, - "reset": 1691591091 - } + "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 }, - "rate": { - "limit": 5000, - "used": 1, - "remaining": 4999, - "reset": 1372700873 - } + "content": "heart", + "created_at": "2016-05-20T20:09:31Z" } } } } - }, - "headers": { - "X-RateLimit-Limit": { - "example": 5000, - "schema": { - "type": "integer" - } - }, - "X-RateLimit-Remaining": { - "example": 4999, - "schema": { - "type": "integer" - } - }, - "X-RateLimit-Reset": { - "example": 1590701888, - "schema": { - "type": "integer", - "format": "timestamp" - } - } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "reactions", + "subcategory": "reactions" + } + } + }, + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { + "delete": { + "summary": "Delete team discussion comment reaction", + "description": "> [!NOTE]\n> You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "tags": [ + "reactions" + ], + "operationId": "reactions/delete-for-team-discussion-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reactions/reactions#delete-team-discussion-comment-reaction" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" } }, - "304": { - "description": "Not modified" + { + "name": "team_slug", + "description": "The slug of the team name.", + "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": "discussion_number", + "description": "The number that identifies the discussion.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "comment_number", + "description": "The number that identifies the comment.", + "in": "path", + "required": true, + "schema": { + "type": "integer" } + }, + { + "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": "rate-limit", - "subcategory": "rate-limit" + "category": "reactions", + "subcategory": "reactions" } } }, - "/repos/{owner}/{repo}": { + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { "get": { - "summary": "Get a repository", - "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n> [!NOTE]\n> In order to see the `security_and_analysis` block for a repository 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).\"", + "summary": "List reactions for a team discussion", + "description": "List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ - "repos" + "reactions" ], - "operationId": "repos/get", + "operationId": "reactions/list-for-team-discussion-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/repos#get-a-repository" + "url": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion" }, "parameters": [ { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { @@ -184933,13 +176725,59 @@ } }, { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "name": "team_slug", + "description": "The slug of the team name.", "in": "path", "required": true, "schema": { "type": "string" } + }, + { + "name": "discussion_number", + "description": "The number that identifies the discussion.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "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.", + "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": { @@ -184948,4116 +176786,2603 @@ "content": { "application/json": { "schema": { - "title": "Full Repository", - "description": "Full Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + "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", + "examples": [ + 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", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" + "node_id": { + "type": "string", + "examples": [ + "MDg6UmVhY3Rpb24x" + ] }, - "examples": [ - "octocat", - "atom", - "electron", - "API" - ] - }, - "has_issues": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_discussions": { - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "type": "string", - "examples": [ - "public" - ] - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "content": { + "description": "The reaction to use", + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "examples": [ + "heart" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-05-20T20:09:31Z" + ] + } }, - "created_at": { - "type": "string", - "format": "date-time", + "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" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "reactions", + "subcategory": "reactions" + } + }, + "post": { + "summary": "Create reaction for a team discussion", + "description": "Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "tags": [ + "reactions" + ], + "operationId": "reactions/create-for-team-discussion-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discussion_number", + "description": "The number that identifies the discussion.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "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 team discussion.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + } + }, + "required": [ + "content" + ] + }, + "examples": { + "default": { + "value": { + "content": "heart" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "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", "examples": [ - "2011-01-26T19:01:12Z" + 1 ] }, - "updated_at": { + "node_id": { "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "allow_rebase_merge": { - "type": "boolean", "examples": [ - true + "MDg6UmVhY3Rpb24x" ] }, - "template_repository": { + "user": { "anyOf": [ { "type": "null" }, { - "title": "Repository", - "description": "A repository on GitHub.", + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 + "name": { + "type": [ + "string", + "null" ] }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "email": { + "type": [ + "string", + "null" ] }, - "name": { - "description": "The name of the repository.", + "login": { "type": "string", "examples": [ - "Team Environment" + "octocat" ] }, - "full_name": { - "type": "string", + "id": { + "type": "integer", + "format": "int64", "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" + 1 ] }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" ] }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { + "avatar_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat/Hello-World" + "https://github.com/images/error/octocat_happy.gif" ] }, - "description": { + "gravatar_id": { "type": [ "string", "null" ], "examples": [ - "This your first repo!" + "41d064eb2195891e12d0413f63227ea7" ] }, - "fork": { - "type": "boolean" - }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + "https://api.github.com/users/octocat" ] }, - "collaborators_url": { + "html_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + "https://github.com/octocat" ] }, - "comments_url": { + "followers_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + "https://api.github.com/users/octocat/followers" ] }, - "commits_url": { + "following_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "compare_url": { + "gists_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "contents_url": { + "starred_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "contributors_url": { + "subscriptions_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" + "https://api.github.com/users/octocat/subscriptions" ] }, - "deployments_url": { + "organizations_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" + "https://api.github.com/users/octocat/orgs" ] }, - "downloads_url": { + "repos_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" + "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "forks_url": { + "received_events_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + "https://api.github.com/users/octocat/received_events" ] }, - "git_refs_url": { + "type": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + "User" ] }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] + "site_admin": { + "type": "boolean" }, - "git_url": { + "starred_at": { "type": "string", "examples": [ - "git:github.com/octocat/Hello-World.git" + "\"2020-07-09T00:17:55Z\"" ] }, - "issue_comment_url": { + "user_view_type": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + "public" ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "content": { + "description": "The reaction to use", + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "examples": [ + "heart" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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": "Response", + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDg6UmVhY3Rpb24x" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" ] }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + "email": { + "type": [ + "string", + "null" ] }, - "keys_url": { + "login": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + "octocat" ] }, - "labels_url": { - "type": "string", + "id": { + "type": "integer", + "format": "int64", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + 1 ] }, - "languages_url": { + "node_id": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" + "MDQ6VXNlcjE=" ] }, - "merges_url": { + "avatar_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + "https://github.com/images/error/octocat_happy.gif" ] }, - "pulls_url": { - "type": "string", + "gravatar_id": { + "type": [ + "string", + "null" + ], "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + "41d064eb2195891e12d0413f63227ea7" ] }, - "releases_url": { + "url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + "https://api.github.com/users/octocat" ] }, - "ssh_url": { + "html_url": { "type": "string", + "format": "uri", "examples": [ - "git@github.com:octocat/Hello-World.git" + "https://github.com/octocat" ] }, - "stargazers_url": { + "followers_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" + "https://api.github.com/users/octocat/followers" ] }, - "statuses_url": { + "following_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "subscribers_url": { + "gists_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "subscription_url": { + "starred_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "tags_url": { + "subscriptions_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" + "https://api.github.com/users/octocat/subscriptions" ] }, - "teams_url": { + "organizations_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + "https://api.github.com/users/octocat/orgs" ] }, - "clone_url": { + "repos_url": { "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], "format": "uri", "examples": [ - "git:git.example.com/octocat/Hello-World" + "https://api.github.com/users/octocat/repos" ] }, - "hooks_url": { + "events_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "svn_url": { + "received_events_url": { "type": "string", "format": "uri", "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 + "https://api.github.com/users/octocat/received_events" ] }, - "default_branch": { - "description": "The default branch of the repository.", + "type": { "type": "string", "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true + "User" ] }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, + "site_admin": { "type": "boolean" }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "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": { + "starred_at": { "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", "examples": [ - true + "\"2020-07-09T00:17:55Z\"" ] }, - "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": { + "user_view_type": { "type": "string", "examples": [ - "\"2020-07-09T00:17:42Z\"" + "public" ] - }, - "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", + "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", - "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" + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] } ] }, - "temp_clone_token": { - "type": [ - "string", - "null" - ] - }, - "allow_squash_merge": { - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "type": "boolean", - "examples": [ - false - ] - }, - "allow_merge_commit": { - "type": "boolean", + "content": { + "description": "The reaction to use", + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], "examples": [ - true + "heart" ] }, - "allow_update_branch": { - "type": "boolean", + "created_at": { + "type": "string", + "format": "date-time", "examples": [ - true - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "examples": [ - false + "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" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "reactions", + "subcategory": "reactions" + } + } + }, + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { + "delete": { + "summary": "Delete team discussion reaction", + "description": "> [!NOTE]\n> You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "tags": [ + "reactions" + ], + "operationId": "reactions/delete-for-team-discussion", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reactions/reactions#delete-team-discussion-reaction" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discussion_number", + "description": "The number that identifies the discussion.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "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" + } + } + }, + "/orgs/{org}/teams/{team_slug}/invitations": { + "get": { + "summary": "List pending team invitations", + "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`.", + "tags": [ + "teams" + ], + "operationId": "teams/list-pending-invitations-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/members#list-pending-team-invitations" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "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": "Organization Invitation", + "description": "Organization Invitation", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "role": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "failed_at": { + "type": [ + "string", + "null" + ] + }, + "failed_reason": { + "type": [ + "string", + "null" + ] + }, + "inviter": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "team_count": { + "type": "integer" + }, + "node_id": { + "type": "string", + "examples": [ + "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" + ] + }, + "invitation_teams_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/organizations/16/invitations/1/teams\"" + ] + }, + "invitation_source": { + "type": "string", + "examples": [ + "\"member\"" + ] + } }, - "squash_merge_commit_title": { + "required": [ + "id", + "login", + "email", + "role", + "created_at", + "inviter", + "team_count", + "invitation_teams_url", + "node_id" + ] + } + }, + "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", + "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 + }, + "team_count": 2, + "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams", + "invitation_source": "member" + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "members" + } + } + }, + "/orgs/{org}/teams/{team_slug}/members": { + "get": { + "summary": "List team members", + "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.", + "tags": [ + "teams" + ], + "operationId": "teams/list-members-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/members#list-team-members" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "role", + "description": "Filters members returned by their role in the team.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "member", + "maintainer", + "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", + "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": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "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 + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "members" + } + } + }, + "/orgs/{org}/teams/{team_slug}/memberships/{username}": { + "get": { + "summary": "Get team membership for a user", + "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team).", + "tags": [ + "teams" + ], + "operationId": "teams/get-membership-for-user-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/members#get-team-membership-for-a-user" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "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": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Team Membership", + "description": "Team Membership", + "type": "object", + "properties": { + "url": { "type": "string", + "format": "uri" + }, + "role": { + "description": "The role of the user in the team.", "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" + "member", + "maintainer" ], - "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).", + "default": "member", + "type": "string", "examples": [ - "PR_TITLE" + "member" ] }, - "squash_merge_commit_message": { + "state": { + "description": "The state of the user's membership in the team.", "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.", - "examples": [ - "PR_BODY" + "active", + "pending" ] - }, - "merge_commit_title": { + } + }, + "required": [ + "role", + "state", + "url" + ] + }, + "examples": { + "response-if-user-is-a-team-maintainer": { + "summary": "Response if user is a team maintainer", + "value": { + "url": "https://api.github.com/teams/1/memberships/octocat", + "role": "maintainer", + "state": "active" + } + } + } + } + } + }, + "404": { + "description": "if user has no team membership" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "members" + } + }, + "put": { + "summary": "Add or update team membership for a user", + "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "tags": [ + "teams" + ], + "operationId": "teams/add-or-update-membership-for-user-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "role": { + "type": "string", + "description": "The role that this user should have in the team.", + "enum": [ + "member", + "maintainer" + ], + "default": "member" + } + } + }, + "examples": { + "default": { + "summary": "Add or update team membership for an organization member", + "value": { + "role": "maintainer" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Team Membership", + "description": "Team Membership", + "type": "object", + "properties": { + "url": { "type": "string", + "format": "uri" + }, + "role": { + "description": "The role of the user in the team.", "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" + "member", + "maintainer" ], - "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).", + "default": "member", + "type": "string", "examples": [ - "PR_TITLE" + "member" ] }, - "merge_commit_message": { + "state": { + "description": "The state of the user's membership in the team.", "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.", - "examples": [ - "PR_BODY" + "active", + "pending" ] + } + }, + "required": [ + "role", + "state", + "url" + ] + }, + "examples": { + "response-if-users-membership-with-team-is-now-pending": { + "summary": "Response if user's membership with team is now pending", + "value": { + "url": "https://api.github.com/teams/1/memberships/octocat", + "role": "member", + "state": "pending" + } + } + } + } + } + }, + "403": { + "description": "Forbidden if team synchronization is set up" + }, + "422": { + "description": "Unprocessable Entity if you attempt to add an organization to a team" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "members" + } + }, + "delete": { + "summary": "Remove team membership for a user", + "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "tags": [ + "teams" + ], + "operationId": "teams/remove-membership-for-user-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "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 if team synchronization is set up" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "members" + } + } + }, + "/orgs/{org}/teams/{team_slug}/projects": { + "get": { + "summary": "List team projects", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "tags": [ + "teams" + ], + "operationId": "teams/list-projects-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/teams#list-team-projects" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "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": "Team Project", + "description": "A team's access to a project.", + "type": "object", + "properties": { + "owner_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "columns_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "number": { + "type": "integer" + }, + "state": { + "type": "string" + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "organization_permission": { + "description": "The organization permission for this project. Only present when owner is an organization.", + "type": "string" + }, + "private": { + "description": "Whether the project is private or not. Only present when owner is an organization.", + "type": "boolean" + }, + "permissions": { + "type": "object", + "properties": { + "read": { + "type": "boolean" + }, + "write": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "read", + "write", + "admin" + ] + } }, - "allow_forking": { - "type": "boolean", - "examples": [ - true - ] + "required": [ + "owner_url", + "url", + "html_url", + "columns_url", + "id", + "node_id", + "name", + "body", + "number", + "state", + "creator", + "created_at", + "updated_at", + "permissions" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "owner_url": "https://api.github.com/orgs/octocat", + "url": "https://api.github.com/projects/1002605", + "html_url": "https://github.com/orgs/api-playground/projects/1", + "columns_url": "https://api.github.com/projects/1002605/columns", + "id": 1002605, + "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", + "name": "Organization Roadmap", + "body": "High-level roadmap for the upcoming year.", + "number": 1, + "state": "open", + "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 + }, + "created_at": "2011-04-11T20:09:31Z", + "updated_at": "2014-03-04T18:58:10Z", + "organization_permission": "write", + "private": false, + "permissions": { + "read": true, + "write": true, + "admin": false + } + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "teams", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true + } + }, + "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { + "get": { + "summary": "Check team permissions for a project", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "tags": [ + "teams" + ], + "operationId": "teams/check-permissions-for-project-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "project_id", + "description": "The unique identifier of the project.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Team Project", + "description": "A team's access to a project.", + "type": "object", + "properties": { + "owner_url": { + "type": "string" }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] + "url": { + "type": "string" }, - "subscribers_count": { - "type": "integer", - "examples": [ - 42 - ] + "html_url": { + "type": "string" }, - "network_count": { - "type": "integer", - "examples": [ - 0 - ] + "columns_url": { + "type": "string" }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] + "id": { + "type": "integer" }, - "organization": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "body": { + "type": [ + "string", + "null" ] }, - "parent": { - "title": "Repository", - "description": "A repository on GitHub.", + "number": { + "type": "integer" + }, + "state": { + "type": "string" + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, "id": { - "description": "Unique identifier of the repository", "type": "integer", "format": "int64", "examples": [ - 42 + 1 ] }, "node_id": { "type": "string", "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "MDQ6VXNlcjE=" ] }, - "name": { - "description": "The name of the repository.", + "avatar_url": { "type": "string", + "format": "uri", "examples": [ - "Team Environment" + "https://github.com/images/error/octocat_happy.gif" ] }, - "full_name": { + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { "type": "string", + "format": "uri", "examples": [ - "octocat/Hello-World" + "https://api.github.com/users/octocat" ] }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" ] }, - "forks": { - "type": "integer" + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { + "gists_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "contents_url": { + "starred_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "contributors_url": { + "subscriptions_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" + "https://api.github.com/users/octocat/subscriptions" ] }, - "deployments_url": { + "organizations_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" + "https://api.github.com/users/octocat/orgs" ] }, - "downloads_url": { + "repos_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" + "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "svn_url": { + "received_events_url": { "type": "string", "format": "uri", "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false + "https://api.github.com/users/octocat/received_events" ] }, - "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": { "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", "examples": [ - true + "User" ] }, - "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, + "site_admin": { "type": "boolean" }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, "starred_at": { "type": "string", "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] - }, - "source": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true + "\"2020-07-09T00:17:55Z\"" ] }, - "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": { + "user_view_type": { "type": "string", "examples": [ - "\"2020-07-09T00:17:42Z\"" + "public" ] - }, - "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", + "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", - "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" + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, - "forks": { - "type": "integer" - }, - "master_branch": { + "created_at": { "type": "string" }, - "open_issues": { - "type": "integer" + "updated_at": { + "type": "string" }, - "watchers": { - "type": "integer" + "organization_permission": { + "description": "The organization permission for this project. Only present when owner is an organization.", + "type": "string" }, - "anonymous_access_enabled": { - "description": "Whether anonymous git access is allowed.", - "default": true, + "private": { + "description": "Whether the project is private or not. Only present when owner is an organization.", "type": "boolean" }, - "code_of_conduct": { - "title": "Code Of Conduct Simple", - "description": "Code of Conduct Simple", + "permissions": { "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/github/docs/community/code_of_conduct" - ] - }, - "key": { - "type": "string", - "examples": [ - "citizen_code_of_conduct" - ] + "read": { + "type": "boolean" }, - "name": { - "type": "string", - "examples": [ - "Citizen Code of Conduct" - ] + "write": { + "type": "boolean" }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md" - ] + "admin": { + "type": "boolean" } }, "required": [ - "url", - "key", - "name", - "html_url" + "read", + "write", + "admin" ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "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", + "owner_url", + "url", "html_url", + "columns_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_issues", - "has_projects", - "has_wiki", - "has_pages", - "has_discussions", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", + "body", + "number", + "state", + "creator", "created_at", "updated_at", - "network_count", - "subscribers_count" + "permissions" ] }, "examples": { - "default-response": { - "summary": "Default response", + "default": { "value": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { + "owner_url": "https://api.github.com/orgs/octocat", + "url": "https://api.github.com/projects/1002605", + "html_url": "https://github.com/orgs/api-playground/projects/1", + "columns_url": "https://api.github.com/projects/1002605/columns", + "id": 1002605, + "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", + "name": "Organization Roadmap", + "body": "High-level roadmap for the upcoming year.", + "number": 1, + "state": "open", + "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -189077,367 +179402,1120 @@ "type": "User", "site_admin": false }, + "created_at": "2011-04-11T20:09:31Z", + "updated_at": "2014-03-04T18:58:10Z", + "organization_permission": "write", "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", - "forks_count": 9, - "forks": 9, - "stargazers_count": 80, - "watchers_count": 80, - "watchers": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "open_issues": 0, - "is_template": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "has_discussions": false, - "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": { - "pull": true, - "push": false, + "read": true, + "write": true, "admin": false - }, - "allow_rebase_merge": true, - "template_repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World-Template", - "full_name": "octocat/Hello-World-Template", - "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-Template", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World-Template", - "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World-Template.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World-Template.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World-Template.git", - "mirror_url": "git:git.example.com/octocat/Hello-World-Template", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World-Template", - "homepage": "https://github.com", - "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" + } + } + } + } + } + } + }, + "404": { + "description": "Not Found if project is not managed by this team" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "teams", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true + }, + "put": { + "summary": "Add or update team project permissions", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "tags": [ + "teams" + ], + "operationId": "teams/add-or-update-project-permissions-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "project_id", + "description": "The unique identifier of the project.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": [ + "object", + "null" + ], + "properties": { + "permission": { + "type": "string", + "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "enum": [ + "read", + "write", + "admin" + ] + } + } + }, + "examples": { + "default": { + "summary": "Updates the permissions for the team to write for the project", + "value": { + "permission": "write" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden if the project is not owned by the organization", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + }, + "examples": { + "response-if-the-project-is-not-owned-by-the-organization": { + "value": { + "message": "Must have admin rights to Repository.", + "documentation_url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "teams", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true + }, + "delete": { + "summary": "Remove a project from a team", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "tags": [ + "teams" + ], + "operationId": "teams/remove-project-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "project_id", + "description": "The unique identifier of the project.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "teams", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true + } + }, + "/orgs/{org}/teams/{team_slug}/repos": { + "get": { + "summary": "List team repositories", + "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", + "tags": [ + "teams" + ], + "operationId": "teams/list-repos-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/teams#list-team-repositories" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "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": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - "topics": [ - "octocat", - "atom", - "electron", - "api" + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" ], - "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 + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "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", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# 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", + "null" + ], + "format": "uri" + } }, - "allow_rebase_merge": true, - "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 + "required": [ + "url", + "html_url", + "key", + "name" + ] }, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "allow_forking": true, - "subscribers_count": 42, - "network_count": 0, "license": { - "key": "mit", - "name": "MIT License", - "spdx_id": "MIT", - "url": "https://api.github.com/licenses/mit", - "node_id": "MDc6TGljZW5zZW1pdA==" + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } }, - "organization": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "Organization", - "site_admin": false + "forks": { + "type": "integer", + "examples": [ + 0 + ] }, - "parent": { - "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" + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" ], - "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, - "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://api.github.com/licenses/mit" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 + "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" + ] + } + } + } + } }, - "source": { + "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": [ + { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", @@ -189509,13 +180587,14 @@ "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, + "is_template": false, "topics": [ "octocat", "atom", @@ -189527,6 +180606,7 @@ "has_wiki": true, "has_pages": false, "has_downloads": true, + "has_discussions": false, "archived": false, "disabled": false, "visibility": "public", @@ -189538,25 +180618,6 @@ "push": false, "pull": true }, - "allow_rebase_merge": true, - "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://api.github.com/licenses/mit" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1, "security_and_analysis": { "advanced_security": { "status": "enabled" @@ -189572,86 +180633,16 @@ } } } - } - } - } - } - } - }, - "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" - } + ] } } } - } - }, - "301": { - "description": "Moved permanently", - "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" } } } @@ -189660,22 +180651,42 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "repos" + "category": "teams", + "subcategory": "teams" } - }, - "patch": { - "summary": "Update a repository", - "description": "**Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/repos/repos#replace-all-repository-topics) endpoint.", + } + }, + "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": { + "get": { + "summary": "Check team permissions for a repository", + "description": "Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header.\n\nIf a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.\n\nIf the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", "tags": [ - "repos" + "teams" ], - "operationId": "repos/update", + "operationId": "teams/check-permissions-for-repo-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/repos#update-a-repository" + "url": "https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository" }, "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.", @@ -189695,249 +180706,21 @@ } } ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository." - }, - "description": { - "type": "string", - "description": "A short description of the repository." - }, - "homepage": { - "type": "string", - "description": "A URL with more information about the repository." - }, - "private": { - "type": "boolean", - "description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", - "default": false - }, - "visibility": { - "type": "string", - "description": "The visibility of the repository.", - "enum": [ - "public", - "private" - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "description": "Specify which security and analysis features to enable or disable for the repository.\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\nFor example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request:\n`{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }`.\n\nYou can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request.", - "properties": { - "advanced_security": { - "type": "object", - "description": "Use the `status` property to enable or disable GitHub Advanced Security for this repository.\nFor more information, see \"[About GitHub Advanced\nSecurity](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.", - "properties": { - "status": { - "type": "string", - "description": "Can be `enabled` or `disabled`." - } - } - }, - "code_security": { - "type": "object", - "description": "Use the `status` property to enable or disable GitHub Code Security for this repository.", - "properties": { - "status": { - "type": "string", - "description": "Can be `enabled` or `disabled`." - } - } - }, - "secret_scanning": { - "type": "object", - "description": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", - "properties": { - "status": { - "type": "string", - "description": "Can be `enabled` or `disabled`." - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "description": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"", - "properties": { - "status": { - "type": "string", - "description": "Can be `enabled` or `disabled`." - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "description": "Use the `status` property to enable or disable secret scanning AI detection for this repository. For more information, see \"[Responsible detection of generic secrets with AI](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/generic-secret-detection/responsible-ai-generic-secrets).\"", - "properties": { - "status": { - "type": "string", - "description": "Can be `enabled` or `disabled`." - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "description": "Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. For more information, see \"[Supported secret scanning patterns](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"", - "properties": { - "status": { - "type": "string", - "description": "Can be `enabled` or `disabled`." - } - } - } - } - }, - "has_issues": { - "type": "boolean", - "description": "Either `true` to enable issues for this repository or `false` to disable them.", - "default": true - }, - "has_projects": { - "type": "boolean", - "description": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", - "default": true - }, - "has_wiki": { - "type": "boolean", - "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", - "default": true - }, - "is_template": { - "type": "boolean", - "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", - "default": false - }, - "default_branch": { - "type": "string", - "description": "Updates the default branch for this repository." - }, - "allow_squash_merge": { - "type": "boolean", - "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", - "default": true - }, - "allow_merge_commit": { - "type": "boolean", - "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", - "default": true - }, - "allow_rebase_merge": { - "type": "boolean", - "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", - "default": true - }, - "allow_auto_merge": { - "type": "boolean", - "description": "Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge.", - "default": false - }, - "delete_branch_on_merge": { - "type": "boolean", - "description": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", - "default": false - }, - "allow_update_branch": { - "type": "boolean", - "description": "Either `true` to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise.", - "default": false - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **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": "Required when using `squash_merge_commit_message`.\n\nThe 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": "Required when using `merge_commit_message`.\n\nThe 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." - }, - "archived": { - "type": "boolean", - "description": "Whether to archive this repository. `false` will unarchive a previously archived repository.", - "default": false - }, - "allow_forking": { - "type": "boolean", - "description": "Either `true` to allow private forks, or `false` to prevent private forks.", - "default": false - }, - "web_commit_signoff_required": { - "type": "boolean", - "description": "Either `true` to require contributors to sign off on web-based commits, or `false` to not require contributors to sign off on web-based commits.", - "default": false - } - } - }, - "examples": { - "default": { - "value": { - "name": "Hello-World", - "description": "This is your first repository", - "homepage": "https://github.com", - "private": true, - "has_issues": true, - "has_projects": true, - "has_wiki": true - } - } - } - } - } - }, "responses": { "200": { - "description": "Response", + "description": "Alternative response with repository permissions", "content": { "application/json": { "schema": { - "title": "Full Repository", - "description": "Full Repository", + "title": "Team Repository", + "description": "A team's access to a repository.", "type": "object", "properties": { "id": { + "description": "Unique identifier of the repository", "type": "integer", - "format": "int64", "examples": [ - 1296269 + 42 ] }, "node_id": { @@ -189947,9 +180730,10 @@ ] }, "name": { + "description": "The name of the repository.", "type": "string", "examples": [ - "Hello-World" + "Team Environment" ] }, "full_name": { @@ -189958,302 +180742,407 @@ "octocat/Hello-World" ] }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "license": { + "anyOf": [ + { + "type": "null" }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" }, - "type": { - "type": "string", - "examples": [ - "User" - ] + "pull": { + "type": "boolean" }, - "site_admin": { + "triage": { "type": "boolean" }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "push": { + "type": "boolean" }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] + "maintain": { + "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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + "admin", + "pull", + "push" ] }, - "git_refs_url": { + "role_name": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + "admin" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { @@ -190454,13 +181343,13 @@ ] }, "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "type": "integer", "examples": [ 108 ] }, "default_branch": { + "description": "The default branch of the repository.", "type": "string", "examples": [ "master" @@ -190473,6 +181362,8 @@ ] }, "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, "type": "boolean", "examples": [ true @@ -190482,27 +181373,27 @@ "type": "array", "items": { "type": "string" - }, - "examples": [ - "octocat", - "atom", - "electron", - "API" - ] + } }, "has_issues": { + "description": "Whether issues are enabled.", + "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { + "description": "Whether projects are enabled.", + "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, "type": "boolean", "examples": [ true @@ -190512,18 +181403,16 @@ "type": "boolean" }, "has_downloads": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_discussions": { + "description": "Whether downloads are enabled.", + "default": true, "type": "boolean", "examples": [ true ] }, "archived": { + "description": "Whether the repository is archived.", + "default": false, "type": "boolean" }, "disabled": { @@ -190532,1491 +181421,3307 @@ }, "visibility": { "description": "The repository visibility: public, private, or internal.", - "type": "string", - "examples": [ - "public" - ] + "default": "public", + "type": "string" }, "pushed_at": { - "type": "string", + "type": [ + "string", + "null" + ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { - "type": "string", + "type": [ + "string", + "null" + ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { - "type": "string", + "type": [ + "string", + "null" + ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true ] }, - "allow_rebase_merge": { + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, "type": "boolean", "examples": [ true ] }, - "template_repository": { + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "examples": { + "alternative-response-with-repository-permissions": { + "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}", + "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": false, + "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, + "maintain": false, + "push": false, + "triage": false, + "pull": true + }, + "role_name": "read", + "allow_rebase_merge": true, + "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://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + } + } + } + } + }, + "204": { + "description": "Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header." + }, + "404": { + "description": "Not Found if team does not have permission for the repository" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "teams" + } + }, + "put": { + "summary": "Add or update team repository permissions", + "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", + "tags": [ + "teams" + ], + "operationId": "teams/add-or-update-repo-permissions-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "permission": { + "type": "string", + "description": "The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository." + } + } + }, + "examples": { + "default": { + "summary": "Adding a team to an organization repository with the write role", + "value": { + "permission": "push" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "teams" + } + }, + "delete": { + "summary": "Remove a repository from a team", + "description": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", + "tags": [ + "teams" + ], + "operationId": "teams/remove-repo-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "teams" + } + } + }, + "/orgs/{org}/teams/{team_slug}/teams": { + "get": { + "summary": "List child teams", + "description": "Lists the child teams of the team specified by `{team_slug}`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`.", + "tags": [ + "teams" + ], + "operationId": "teams/list-child-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/teams#list-child-teams" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "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": "if child teams exist", + "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", + "null" + ] + }, + "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", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "examples": { + "response-if-child-teams-exist": { + "value": [ + { + "id": 2, + "node_id": "MDQ6VGVhbTI=", + "url": "https://api.github.com/teams/2", + "name": "Original Roster", + "slug": "original-roster", + "description": "Started it all.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/2/members{/member}", + "repositories_url": "https://api.github.com/teams/2/repos", + "parent": { + "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" + }, + "html_url": "https://github.com/orgs/rails/teams/core" + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "teams" + } + } + }, + "/orgs/{org}/{security_product}/{enablement}": { + "post": { + "summary": "Enable or disable a security feature for an organization", + "description": "> [!WARNING]\n> **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/).\n\nEnables or disables the specified security feature for all eligible repositories in an organization. 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 organization owner or be member of a team with the security manager role to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/enable-or-disable-security-product-on-all-org-repos", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "security_product", + "in": "path", + "description": "The security feature to enable or disable.", + "required": true, + "schema": { + "type": "string", + "enum": [ + "dependency_graph", + "dependabot_alerts", + "dependabot_security_updates", + "advanced_security", + "code_scanning_default_setup", + "secret_scanning", + "secret_scanning_push_protection" + ] + } + }, + { + "name": "enablement", + "in": "path", + "description": "The action to take.\n\n`enable_all` means to enable the specified security feature for all repositories in the organization.\n`disable_all` means to disable the specified security feature for all repositories in the organization.", + "required": true, + "schema": { + "type": "string", + "enum": [ + "enable_all", + "disable_all" + ] + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "query_suite": { + "description": "CodeQL query suite to be used. If you specify the `query_suite` parameter, the default setup will be configured with this query suite only on all repositories that didn't have default setup already configured. It will not change the query suite on repositories that already have default setup configured.\nIf you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied.", + "type": "string", + "enum": [ + "default", + "extended" + ] + } + } + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "responses": { + "204": { + "description": "Action started" + }, + "422": { + "description": "The action could not be taken due to an in progress enablement, or a policy is preventing enablement" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "orgs", + "deprecationDate": "2024-07-22", + "removalDate": "2025-07-22" + }, + "deprecated": true + } + }, + "/projects/columns/cards/{card_id}": { + "get": { + "summary": "Get a project card", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "tags": [ + "projects-classic" + ], + "operationId": "projects-classic/get-card", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects-classic/cards#get-a-project-card" + }, + "parameters": [ + { + "name": "card_id", + "description": "The unique identifier of the card.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Project Card", + "description": "Project cards represent a scope of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/cards/1478" + ] + }, + "id": { + "description": "The project card's ID", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOlByb2plY3RDYXJkMTQ3OA==" + ] + }, + "note": { + "type": [ + "string", + "null" + ], + "examples": [ + "Add payload for delete Project column" + ] + }, + "creator": { "anyOf": [ { "type": "null" }, { - "title": "Repository", - "description": "A repository on GitHub.", + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 + "name": { + "type": [ + "string", + "null" ] }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "email": { + "type": [ + "string", + "null" ] }, - "name": { - "description": "The name of the repository.", + "login": { "type": "string", "examples": [ - "Team Environment" + "octocat" ] }, - "full_name": { - "type": "string", + "id": { + "type": "integer", + "format": "int64", "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" + 1 ] }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" ] }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { + "avatar_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat/Hello-World" + "https://github.com/images/error/octocat_happy.gif" ] }, - "description": { + "gravatar_id": { "type": [ "string", "null" ], "examples": [ - "This your first repo!" + "41d064eb2195891e12d0413f63227ea7" ] }, - "fork": { - "type": "boolean" - }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World" + "https://api.github.com/users/octocat" ] }, - "archive_url": { + "html_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + "https://github.com/octocat" ] }, - "assignees_url": { + "followers_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + "https://api.github.com/users/octocat/followers" ] }, - "blobs_url": { + "following_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "branches_url": { + "gists_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "collaborators_url": { + "starred_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "comments_url": { + "subscriptions_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + "https://api.github.com/users/octocat/subscriptions" ] }, - "commits_url": { + "organizations_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "https://api.github.com/users/octocat/orgs" ] }, - "compare_url": { + "repos_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "https://api.github.com/users/octocat/repos" ] }, - "contents_url": { + "events_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "contributors_url": { + "received_events_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" + "https://api.github.com/users/octocat/received_events" ] }, - "deployments_url": { + "type": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" + "User" ] }, - "downloads_url": { + "site_admin": { + "type": "boolean" + }, + "starred_at": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" + "\"2020-07-09T00:17:55Z\"" ] }, - "events_url": { + "user_view_type": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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", + "examples": [ + "2016-09-05T14:21:06Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:20:22Z" + ] + }, + "archived": { + "description": "Whether or not the card is archived", + "type": "boolean", + "examples": [ + false + ] + }, + "column_name": { + "type": "string" + }, + "project_id": { + "type": "string" + }, + "column_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" + ] + }, + "content_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test/issues/3" + ] + }, + "project_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/120" + ] + } + }, + "required": [ + "id", + "node_id", + "note", + "url", + "column_url", + "project_url", + "creator", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "url": "https://api.github.com/projects/columns/cards/1478", + "id": 1478, + "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", + "note": "Add payload for delete Project column", + "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 + }, + "created_at": "2016-09-05T14:21:06Z", + "updated_at": "2016-09-05T14:20:22Z", + "archived": false, + "column_url": "https://api.github.com/projects/columns/367", + "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", + "project_url": "https://api.github.com/projects/120" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "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" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/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": "projects-classic", + "subcategory": "cards", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true + }, + "patch": { + "summary": "Update an existing project card", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "tags": [ + "projects-classic" + ], + "operationId": "projects-classic/update-card", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects-classic/cards#update-an-existing-project-card" + }, + "parameters": [ + { + "name": "card_id", + "description": "The unique identifier of the card.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "note": { + "description": "The project card's note", + "type": [ + "string", + "null" + ], + "examples": [ + "Update all gems" + ] + }, + "archived": { + "description": "Whether or not the card is archived", + "type": "boolean", + "examples": [ + false + ] + } + } + }, + "examples": { + "default": { + "summary": "Change the note on the card", + "value": { + "note": "Add payload for delete Project column" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Project Card", + "description": "Project cards represent a scope of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/cards/1478" + ] + }, + "id": { + "description": "The project card's ID", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOlByb2plY3RDYXJkMTQ3OA==" + ] + }, + "note": { + "type": [ + "string", + "null" + ], + "examples": [ + "Add payload for delete Project column" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" ] }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" + "email": { + "type": [ + "string", + "null" ] }, - "git_commits_url": { + "login": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + "octocat" ] }, - "git_refs_url": { - "type": "string", + "id": { + "type": "integer", + "format": "int64", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + 1 ] }, - "git_tags_url": { + "node_id": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + "MDQ6VXNlcjE=" ] }, - "git_url": { + "avatar_url": { "type": "string", + "format": "uri", "examples": [ - "git:github.com/octocat/Hello-World.git" + "https://github.com/images/error/octocat_happy.gif" ] }, - "issue_comment_url": { - "type": "string", + "gravatar_id": { + "type": [ + "string", + "null" + ], "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + "41d064eb2195891e12d0413f63227ea7" ] }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { + "url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" + "https://api.github.com/users/octocat" ] }, - "merges_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" + "https://github.com/octocat" ] }, - "stargazers_url": { + "followers_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" + "https://api.github.com/users/octocat/followers" ] }, - "statuses_url": { + "following_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "subscribers_url": { + "gists_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "subscription_url": { + "starred_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "tags_url": { + "subscriptions_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" + "https://api.github.com/users/octocat/subscriptions" ] }, - "teams_url": { + "organizations_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + "https://api.github.com/users/octocat/orgs" ] }, - "clone_url": { + "repos_url": { "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], "format": "uri", "examples": [ - "git:git.example.com/octocat/Hello-World" + "https://api.github.com/users/octocat/repos" ] }, - "hooks_url": { + "events_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "svn_url": { + "received_events_url": { "type": "string", "format": "uri", "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 + "https://api.github.com/users/octocat/received_events" ] }, - "default_branch": { - "description": "The default branch of the repository.", + "type": { "type": "string", "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true + "User" ] }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, + "site_admin": { "type": "boolean" }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "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": { + "starred_at": { "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", "examples": [ - true + "\"2020-07-09T00:17:55Z\"" ] }, - "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": { + "user_view_type": { "type": "string", "examples": [ - "\"2020-07-09T00:17:42Z\"" + "public" ] - }, - "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", + "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", - "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" + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] } ] }, - "temp_clone_token": { - "type": [ - "string", - "null" + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:21:06Z" ] }, - "allow_squash_merge": { - "type": "boolean", + "updated_at": { + "type": "string", + "format": "date-time", "examples": [ - true + "2016-09-05T14:20:22Z" ] }, - "allow_auto_merge": { + "archived": { + "description": "Whether or not the card is archived", "type": "boolean", "examples": [ false ] }, - "delete_branch_on_merge": { - "type": "boolean", + "column_name": { + "type": "string" + }, + "project_id": { + "type": "string" + }, + "column_url": { + "type": "string", + "format": "uri", "examples": [ - false + "https://api.github.com/projects/columns/367" ] }, - "allow_merge_commit": { - "type": "boolean", + "content_url": { + "type": "string", + "format": "uri", "examples": [ - true + "https://api.github.com/repos/api-playground/projects-test/issues/3" ] }, - "allow_update_branch": { - "type": "boolean", + "project_url": { + "type": "string", + "format": "uri", "examples": [ - true + "https://api.github.com/projects/120" ] + } + }, + "required": [ + "id", + "node_id", + "note", + "url", + "column_url", + "project_url", + "creator", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "url": "https://api.github.com/projects/columns/cards/1478", + "id": 1478, + "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", + "note": "Add payload for delete Project column", + "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 + }, + "created_at": "2016-09-05T14:21:06Z", + "updated_at": "2016-09-05T14:20:22Z", + "archived": false, + "column_url": "https://api.github.com/projects/columns/367", + "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", + "project_url": "https://api.github.com/projects/120" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "use_squash_pr_title_as_default": { - "type": "boolean", + "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" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/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": "projects-classic", + "subcategory": "cards", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true + }, + "delete": { + "summary": "Delete a project card", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "tags": [ + "projects-classic" + ], + "operationId": "projects-classic/delete-card", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects-classic/cards#delete-a-project-card" + }, + "parameters": [ + { + "name": "card_id", + "description": "The unique identifier of the card.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "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" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/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": "projects-classic", + "subcategory": "cards", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true + } + }, + "/projects/columns/cards/{card_id}/moves": { + "post": { + "summary": "Move a project card", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "tags": [ + "projects-classic" + ], + "operationId": "projects-classic/move-card", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects-classic/cards#move-a-project-card" + }, + "parameters": [ + { + "name": "card_id", + "description": "The unique identifier of the card.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "position": { + "description": "The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card.", + "type": "string", + "pattern": "^(?:top|bottom|after:\\d+)$", + "examples": [ + "bottom" + ] + }, + "column_id": { + "description": "The unique identifier of the column the card should be moved to", + "type": "integer", + "examples": [ + 42 + ] + } + }, + "required": [ + "position" + ], + "type": "object" + }, + "examples": { + "default": { + "summary": "Move the card to the bottom of the column", + "value": { + "column_id": 42, + "position": "bottom" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": {}, + "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "resource": { + "type": "string" + }, + "field": { + "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" + } + } + } + } + } + }, + "503": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects-classic", + "subcategory": "cards", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true + } + }, + "/projects/columns/{column_id}": { + "get": { + "summary": "Get a project column", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "tags": [ + "projects-classic" + ], + "operationId": "projects-classic/get-column", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects-classic/columns#get-a-project-column" + }, + "parameters": [ + { + "name": "column_id", + "description": "The unique identifier of the column.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Project Column", + "description": "Project columns contain cards of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", "examples": [ - false + "https://api.github.com/projects/columns/367" ] }, - "squash_merge_commit_title": { + "project_url": { "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).", + "format": "uri", "examples": [ - "PR_TITLE" + "https://api.github.com/projects/120" ] }, - "squash_merge_commit_message": { + "cards_url": { "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.", + "format": "uri", "examples": [ - "PR_BODY" + "https://api.github.com/projects/columns/367/cards" ] }, - "merge_commit_title": { + "id": { + "description": "The unique identifier of the project column", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { "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).", "examples": [ - "PR_TITLE" + "MDEzOlByb2plY3RDb2x1bW4zNjc=" ] }, - "merge_commit_message": { + "name": { + "description": "Name of the project column", "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.", "examples": [ - "PR_BODY" + "Remaining tasks" ] }, - "allow_forking": { - "type": "boolean", + "created_at": { + "type": "string", + "format": "date-time", "examples": [ - true + "2016-09-05T14:18:44Z" ] }, - "web_commit_signoff_required": { - "type": "boolean", + "updated_at": { + "type": "string", + "format": "date-time", "examples": [ - false + "2016-09-05T14:22:28Z" ] + } + }, + "required": [ + "id", + "node_id", + "url", + "project_url", + "cards_url", + "name", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "url": "https://api.github.com/projects/columns/367", + "project_url": "https://api.github.com/projects/120", + "cards_url": "https://api.github.com/projects/columns/367/cards", + "id": 367, + "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", + "name": "To Do", + "created_at": "2016-09-05T14:18:44Z", + "updated_at": "2016-09-05T14:22:28Z" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "subscribers_count": { + "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" + } + } + } + } + } + }, + "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": true, + "category": "projects-classic", + "subcategory": "columns", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true + }, + "patch": { + "summary": "Update an existing project column", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "tags": [ + "projects-classic" + ], + "operationId": "projects-classic/update-column", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects-classic/columns#update-an-existing-project-column" + }, + "parameters": [ + { + "name": "column_id", + "description": "The unique identifier of the column.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "description": "Name of the project column", + "type": "string", + "examples": [ + "Remaining tasks" + ] + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "examples": { + "default": { + "summary": "Rename the project column", + "value": { + "name": "To Do" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Project Column", + "description": "Project columns contain cards of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" + ] + }, + "project_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/120" + ] + }, + "cards_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367/cards" + ] + }, + "id": { + "description": "The unique identifier of the project column", "type": "integer", "examples": [ 42 ] }, - "network_count": { - "type": "integer", + "node_id": { + "type": "string", "examples": [ - 0 + "MDEzOlByb2plY3RDb2x1bW4zNjc=" ] }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } + "name": { + "description": "Name of the project column", + "type": "string", + "examples": [ + "Remaining tasks" ] }, - "organization": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:18:44Z" ] }, - "parent": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:22:28Z" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "project_url", + "cards_url", + "name", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "url": "https://api.github.com/projects/columns/367", + "project_url": "https://api.github.com/projects/120", + "cards_url": "https://api.github.com/projects/columns/367/cards", + "id": 367, + "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", + "name": "To Do", + "created_at": "2016-09-05T14:18:44Z", + "updated_at": "2016-09-05T14:22:28Z" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "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": true, + "category": "projects-classic", + "subcategory": "columns", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true + }, + "delete": { + "summary": "Delete a project column", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "tags": [ + "projects-classic" + ], + "operationId": "projects-classic/delete-column", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects-classic/columns#delete-a-project-column" + }, + "parameters": [ + { + "name": "column_id", + "description": "The unique identifier of the column.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "304": { + "description": "Not modified" + }, + "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": true, + "category": "projects-classic", + "subcategory": "columns", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true + } + }, + "/projects/columns/{column_id}/cards": { + "get": { + "summary": "List project cards", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "tags": [ + "projects-classic" + ], + "operationId": "projects-classic/list-cards", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects-classic/cards#list-project-cards" + }, + "parameters": [ + { + "name": "column_id", + "description": "The unique identifier of the column.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "archived_state", + "description": "Filters the project cards that are returned by the card's state.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "all", + "archived", + "not_archived" + ], + "default": "not_archived" + } + }, + { + "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": "Project Card", + "description": "Project cards represent a scope of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/cards/1478" + ] + }, + "id": { + "description": "The project card's ID", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOlByb2plY3RDYXJkMTQ3OA==" + ] + }, + "note": { + "type": [ + "string", + "null" + ], + "examples": [ + "Add payload for delete Project column" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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", + "examples": [ + "2016-09-05T14:21:06Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:20:22Z" + ] + }, + "archived": { + "description": "Whether or not the card is archived", + "type": "boolean", + "examples": [ + false + ] + }, + "column_name": { + "type": "string" + }, + "project_id": { + "type": "string" + }, + "column_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" + ] + }, + "content_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test/issues/3" + ] + }, + "project_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/120" + ] + } + }, + "required": [ + "id", + "node_id", + "note", + "url", + "column_url", + "project_url", + "creator", + "created_at", + "updated_at" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "url": "https://api.github.com/projects/columns/cards/1478", + "id": 1478, + "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", + "note": "Add payload for delete Project column", + "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 }, - "owner": { + "created_at": "2016-09-05T14:21:06Z", + "updated_at": "2016-09-05T14:20:22Z", + "archived": false, + "column_url": "https://api.github.com/projects/columns/367", + "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", + "project_url": "https://api.github.com/projects/120" + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "304": { + "description": "Not modified" + }, + "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": true, + "category": "projects-classic", + "subcategory": "cards", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true + }, + "post": { + "summary": "Create a project card", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "tags": [ + "projects-classic" + ], + "operationId": "projects-classic/create-card", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects-classic/cards#create-a-project-card" + }, + "parameters": [ + { + "name": "column_id", + "description": "The unique identifier of the column.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "note": { + "description": "The project card's note", + "type": [ + "string", + "null" + ], + "examples": [ + "Update all gems" + ] + } + }, + "required": [ + "note" + ] + }, + { + "type": "object", + "properties": { + "content_id": { + "description": "The unique identifier of the content associated with the card", + "type": "integer", + "examples": [ + 42 + ] + }, + "content_type": { + "description": "The piece of content associated with the card", + "type": "string", + "examples": [ + "PullRequest" + ] + } + }, + "required": [ + "content_id", + "content_type" + ] + } + ] + }, + "examples": { + "default": { + "summary": "Create a new card", + "value": { + "note": "Add payload for delete Project column" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Project Card", + "description": "Project cards represent a scope of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/cards/1478" + ] + }, + "id": { + "description": "The project card's ID", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOlByb2plY3RDYXJkMTQ3OA==" + ] + }, + "note": { + "type": [ + "string", + "null" + ], + "examples": [ + "Add payload for delete Project column" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -192183,789 +184888,591 @@ "type", "url" ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:21:06Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:20:22Z" + ] + }, + "archived": { + "description": "Whether or not the card is archived", + "type": "boolean", + "examples": [ + false + ] + }, + "column_name": { + "type": "string" + }, + "project_id": { + "type": "string" + }, + "column_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" + ] + }, + "content_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test/issues/3" + ] + }, + "project_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/120" + ] + } + }, + "required": [ + "id", + "node_id", + "note", + "url", + "column_url", + "project_url", + "creator", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "url": "https://api.github.com/projects/columns/cards/1478", + "id": 1478, + "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", + "note": "Add payload for delete Project column", + "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 + }, + "created_at": "2016-09-05T14:21:06Z", + "updated_at": "2016-09-05T14:20:22Z", + "archived": false, + "column_url": "https://api.github.com/projects/columns/367", + "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", + "project_url": "https://api.github.com/projects/120" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "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" + } + } + } + } + } + }, + "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" }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { + "documentation_url": { "type": "string" }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } } } } - }, - "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" - ] + } }, - "source": { - "title": "Repository", - "description": "A repository on GitHub.", + { + "title": "Validation Error Simple", + "description": "Validation Error Simple", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] + "message": { + "type": "string" }, - "forks": { - "type": "integer" + "documentation_url": { + "type": "string" }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } + "errors": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + ] + } + } + } + }, + "503": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "code": { + "type": "string" }, - "required": [ - "admin", - "pull", - "push" - ] + "message": { + "type": "string" + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects-classic", + "subcategory": "cards", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true + } + }, + "/projects/columns/{column_id}/moves": { + "post": { + "summary": "Move a project column", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "tags": [ + "projects-classic" + ], + "operationId": "projects-classic/move-column", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects-classic/columns#move-a-project-column" + }, + "parameters": [ + { + "name": "column_id", + "description": "The unique identifier of the column.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "position": { + "description": "The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column.", + "type": "string", + "pattern": "^(?:first|last|after:\\d+)$", + "examples": [ + "last" + ] + } + }, + "required": [ + "position" + ], + "type": "object" + }, + "examples": { + "default": { + "summary": "Move the column to the end of the board", + "value": { + "position": "last" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": {}, + "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "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" + } + } + } + } + } + }, + "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" + } + } + } + } + } + } + }, + "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": true, + "category": "projects-classic", + "subcategory": "columns", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true + } + }, + "/projects/{project_id}": { + "get": { + "summary": "Get a project", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "tags": [ + "projects-classic" + ], + "operationId": "projects-classic/get", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects-classic/projects#get-a-project" + }, + "parameters": [ + { + "name": "project_id", + "description": "The unique identifier of the project.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", + "type": "object", + "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/api-playground/projects-test/projects/12" + ] + }, + "columns_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604/columns" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6UHJvamVjdDEwMDI2MDQ=" + ] + }, + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", + "type": [ + "string", + "null" + ], + "examples": [ + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" }, - "owner": { + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -193132,912 +185639,557 @@ "type", "url" ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" ] }, - "forks": { - "type": "integer" + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] }, - "master_branch": { + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "type": "string", + "enum": [ + "read", + "write", + "admin", + "none" + ] + }, + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "number", + "name", + "body", + "state", + "url", + "html_url", + "owner_url", + "creator", + "columns_url", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "owner_url": "https://api.github.com/repos/api-playground/projects-test", + "url": "https://api.github.com/projects/1002604", + "html_url": "https://github.com/api-playground/projects-test/projects/1", + "columns_url": "https://api.github.com/projects/1002604/columns", + "id": 1002604, + "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", + "name": "Projects Documentation", + "body": "Developer documentation project for the developer site.", + "number": 1, + "state": "open", + "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 + }, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { "type": "string" }, - "open_issues": { - "type": "integer" + "documentation_url": { + "type": "string" }, - "watchers": { - "type": "integer" + "url": { + "type": "string" }, - "anonymous_access_enabled": { - "description": "Whether anonymous git access is allowed.", - "default": true, - "type": "boolean" + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "code_of_conduct": { - "title": "Code Of Conduct Simple", - "description": "Code of Conduct Simple", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/github/docs/community/code_of_conduct" - ] - }, - "key": { - "type": "string", - "examples": [ - "citizen_code_of_conduct" - ] - }, - "name": { - "type": "string", - "examples": [ - "Citizen Code of Conduct" - ] - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md" - ] - } - }, - "required": [ - "url", - "key", - "name", - "html_url" + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects-classic", + "subcategory": "projects", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true + }, + "patch": { + "summary": "Update a project", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "operationId": "projects-classic/update", + "tags": [ + "projects-classic" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects-classic/projects#update-a-project" + }, + "parameters": [ + { + "name": "project_id", + "description": "The unique identifier of the project.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", + "type": [ + "string", + "null" + ], + "examples": [ + "This project represents the sprint of the first week in January" + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "organization_permission": { + "description": "The baseline permission that all organization members have on this project", + "type": "string", + "enum": [ + "read", + "write", + "admin", + "none" + ] + }, + "private": { + "description": "Whether or not this project can be seen by everyone.", + "type": "boolean" + } + }, + "type": "object" + }, + "examples": { + "default": { + "summary": "Change the name, state, and permissions for a project", + "value": { + "name": "Week One Sprint", + "state": "open", + "organization_permission": "write" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", + "type": "object", + "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" ] }, - "security_and_analysis": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/api-playground/projects-test/projects/12" + ] + }, + "columns_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604/columns" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6UHJvamVjdDEwMDI2MDQ=" + ] + }, + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", "type": [ - "object", + "string", "null" ], - "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", + "examples": [ + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "status": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { "type": "string", - "enum": [ - "enabled", - "disabled" + "examples": [ + "octocat" ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { "type": "string", - "enum": [ - "enabled", - "disabled" + "examples": [ + "MDQ6VXNlcjE=" ] - } - } - }, - "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.", + }, + "avatar_url": { "type": "string", - "enum": [ - "enabled", - "disabled" + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { "type": "string", - "enum": [ - "enabled", - "disabled" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { + }, + "html_url": { "type": "string", - "enum": [ - "enabled", - "disabled" + "format": "uri", + "examples": [ + "https://github.com/octocat" ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { + }, + "followers_url": { "type": "string", - "enum": [ - "enabled", - "disabled" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { + }, + "following_url": { "type": "string", - "enum": [ - "enabled", - "disabled" + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] } - } + ] }, - "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 + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "type": "string", + "enum": [ + "read", + "write", + "admin", + "none" + ] + }, + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "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", + "number", "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", + "body", + "state", "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "has_discussions", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", + "html_url", + "owner_url", + "creator", + "columns_url", "created_at", - "updated_at", - "network_count", - "subscribers_count" + "updated_at" ] }, "examples": { "default": { "value": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { + "owner_url": "https://api.github.com/repos/api-playground/projects-test", + "url": "https://api.github.com/projects/1002604", + "html_url": "https://github.com/api-playground/projects-test/projects/1", + "columns_url": "https://api.github.com/projects/1002604/columns", + "id": 1002604, + "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", + "name": "Projects Documentation", + "body": "Developer documentation project for the developer site.", + "number": 1, + "state": "open", + "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -194057,489 +186209,37 @@ "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", - "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" - }, - "language": null, - "forks_count": 9, - "forks": 9, - "stargazers_count": 80, - "watchers_count": 80, - "watchers": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "open_issues": 0, - "is_template": false, - "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": { - "pull": true, - "push": false, - "admin": false - }, - "allow_rebase_merge": true, - "template_repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World-Template", - "full_name": "octocat/Hello-World-Template", - "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-Template", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World-Template", - "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World-Template.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World-Template.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World-Template.git", - "mirror_url": "git:git.example.com/octocat/Hello-World-Template", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World-Template", - "homepage": "https://github.com", - "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, - "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", - "allow_squash_merge": true, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "allow_forking": true, - "web_commit_signoff_required": false, - "subscribers_count": 42, - "network_count": 0, - "organization": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "Organization", - "site_admin": false - }, - "parent": { - "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, - "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://api.github.com/licenses/mit" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 - }, - "source": { - "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, - "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://api.github.com/licenses/mit" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" + } + } + } + } + } + }, + "404": { + "description": "Not Found if the authenticated user does not have access to the project" + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "string" } } } @@ -194547,8 +186247,8 @@ } } }, - "307": { - "description": "Temporary Redirect", + "401": { + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -194573,8 +186273,8 @@ } } }, - "403": { - "description": "Forbidden", + "410": { + "description": "Gone", "content": { "application/json": { "schema": { @@ -194604,8 +186304,8 @@ "content": { "application/json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", + "title": "Validation Error Simple", + "description": "Validation Error Simple", "type": "object", "required": [ "message", @@ -194621,130 +186321,56 @@ "errors": { "type": "array", "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } + "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": "repos", - "subcategory": "repos" - } + "category": "projects-classic", + "subcategory": "projects", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true }, "delete": { - "summary": "Delete a repository", - "description": "Deleting a repository requires admin access.\n\nIf an organization owner has configured the organization to prevent members from deleting organization-owned\nrepositories, you will get a `403 Forbidden` response.\n\nOAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint.", + "summary": "Delete a project", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "operationId": "projects-classic/delete", "tags": [ - "repos" + "projects-classic" ], - "operationId": "repos/delete", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/repos#delete-a-repository" + "url": "https://docs.github.com/rest/projects-classic/projects#delete-a-project" }, "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.", + "name": "project_id", + "description": "The unique identifier of the project.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], "responses": { "204": { - "description": "Response" + "description": "Delete Success" + }, + "304": { + "description": "Not modified" }, "403": { - "description": "If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response:", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -194755,22 +186381,20 @@ }, "documentation_url": { "type": "string" - } - } - }, - "examples": { - "default": { - "value": { - "message": "Organization members cannot delete repositories.", - "documentation_url": "https://docs.github.com/rest/repos/repos#delete-a-repository" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } } } } } } }, - "307": { - "description": "Temporary Redirect", + "401": { + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -194795,8 +186419,8 @@ } } }, - "404": { - "description": "Resource not found", + "410": { + "description": "Gone", "content": { "application/json": { "schema": { @@ -194821,8 +186445,8 @@ } } }, - "409": { - "description": "Conflict", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -194851,40 +186475,49 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "repos" - } + "category": "projects-classic", + "subcategory": "projects", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true } }, - "/repos/{owner}/{repo}/actions/artifacts": { + "/projects/{project_id}/collaborators": { "get": { - "summary": "List artifacts for a repository", - "description": "Lists all artifacts for a repository.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "summary": "List project collaborators", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ - "actions" + "projects-classic" ], - "operationId": "actions/list-artifacts-for-repo", + "operationId": "projects-classic/list-collaborators", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository" + "url": "https://docs.github.com/rest/projects-classic/collaborators#list-project-collaborators" }, "parameters": [ { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", + "name": "project_id", + "description": "The unique identifier of the project.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } }, { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, + "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 organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see.", + "in": "query", + "required": false, "schema": { - "type": "string" + "type": "string", + "enum": [ + "outside", + "direct", + "all" + ], + "default": "all" } }, { @@ -194904,15 +186537,6 @@ "type": "integer", "default": 1 } - }, - { - "name": "name", - "description": "The name field of an artifact. When specified, only artifacts with this name will be returned.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } } ], "responses": { @@ -194921,546 +186545,215 @@ "content": { "application/json": { "schema": { - "type": "object", - "required": [ - "total_count", - "artifacts" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "artifacts": { - "type": "array", - "items": { - "title": "Artifact", - "description": "An artifact", - "type": "object", - "properties": { - "id": { - "type": "integer", - "examples": [ - 5 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOkNoZWNrU3VpdGU1" - ] - }, - "name": { - "description": "The name of the artifact.", - "type": "string", - "examples": [ - "AdventureWorks.Framework" - ] - }, - "size_in_bytes": { - "description": "The size in bytes of the artifact.", - "type": "integer", - "examples": [ - 12345 - ] - }, - "url": { - "type": "string", - "examples": [ - "https://api.github.com/repos/github/hello-world/actions/artifacts/5" - ] - }, - "archive_download_url": { - "type": "string", - "examples": [ - "https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip" - ] - }, - "expired": { - "description": "Whether or not the artifact has expired.", - "type": "boolean" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "expires_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "digest": { - "type": [ - "string", - "null" - ], - "description": "The SHA256 digest of the artifact. This field will only be populated on artifacts uploaded with upload-artifact v4 or newer. For older versions, this field will be null.", - "examples": [ - "sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c" - ] - }, - "workflow_run": { - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "examples": [ - 10 - ] - }, - "repository_id": { - "type": "integer", - "examples": [ - 42 - ] - }, - "head_repository_id": { - "type": "integer", - "examples": [ - 42 - ] - }, - "head_branch": { - "type": "string", - "examples": [ - "main" - ] - }, - "head_sha": { - "type": "string", - "examples": [ - "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" - ] - } - } - } - }, - "required": [ - "id", - "node_id", - "name", - "size_in_bytes", - "url", - "archive_download_url", - "expired", - "created_at", - "expires_at", - "updated_at" + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 2, - "artifacts": [ - { - "id": 11, - "node_id": "MDg6QXJ0aWZhY3QxMQ==", - "name": "Rails", - "size_in_bytes": 556, - "url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11", - "archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip", - "expired": false, - "created_at": "2020-01-10T14:59:22Z", - "expires_at": "2020-03-21T14:59:22Z", - "updated_at": "2020-02-21T14:59:22Z", - "digest": "sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c", - "workflow_run": { - "id": 2332938, - "repository_id": 1296269, - "head_repository_id": 1296269, - "head_branch": "main", - "head_sha": "328faa0536e6fef19753d9d91dc96a9931694ce3" - } - }, - { - "id": 13, - "node_id": "MDg6QXJ0aWZhY3QxMw==", - "name": "Test output", - "size_in_bytes": 453, - "url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13", - "archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13/zip", - "expired": false, - "created_at": "2020-01-10T14:59:22Z", - "expires_at": "2020-03-21T14:59:22Z", - "updated_at": "2020-02-21T14:59:22Z", - "digest": "sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c", - "workflow_run": { - "id": 2332942, - "repository_id": 1296269, - "head_repository_id": 1296269, - "head_branch": "main", - "head_sha": "178f4f6090b3fccad4a65b3e83d076a622d59652" - } - } - ] - } - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "artifacts" - } - } - }, - "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}": { - "get": { - "summary": "Get an artifact", - "description": "Gets a specific artifact for a workflow run.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/get-artifact", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/artifacts#get-an-artifact" - }, - "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": "artifact_id", - "description": "The unique identifier of the artifact.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Artifact", - "description": "An artifact", - "type": "object", - "properties": { - "id": { - "type": "integer", - "examples": [ - 5 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOkNoZWNrU3VpdGU1" - ] - }, - "name": { - "description": "The name of the artifact.", - "type": "string", - "examples": [ - "AdventureWorks.Framework" - ] - }, - "size_in_bytes": { - "description": "The size in bytes of the artifact.", - "type": "integer", - "examples": [ - 12345 - ] - }, - "url": { - "type": "string", - "examples": [ - "https://api.github.com/repos/github/hello-world/actions/artifacts/5" - ] - }, - "archive_download_url": { - "type": "string", - "examples": [ - "https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip" - ] - }, - "expired": { - "description": "Whether or not the artifact has expired.", - "type": "boolean" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "expires_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "digest": { - "type": [ - "string", - "null" - ], - "description": "The SHA256 digest of the artifact. This field will only be populated on artifacts uploaded with upload-artifact v4 or newer. For older versions, this field will be null.", - "examples": [ - "sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c" - ] - }, - "workflow_run": { - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "examples": [ - 10 - ] - }, - "repository_id": { - "type": "integer", - "examples": [ - 42 - ] - }, - "head_repository_id": { - "type": "integer", - "examples": [ - 42 - ] - }, - "head_branch": { - "type": "string", - "examples": [ - "main" - ] - }, - "head_sha": { - "type": "string", - "examples": [ - "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" - ] - } - } - } - }, - "required": [ - "id", - "node_id", - "name", - "size_in_bytes", - "url", - "archive_download_url", - "expired", - "created_at", - "expires_at", - "updated_at" - ] + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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": 11, - "node_id": "MDg6QXJ0aWZhY3QxMQ==", - "name": "Rails", - "size_in_bytes": 556, - "url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11", - "archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip", - "expired": false, - "created_at": "2020-01-10T14:59:22Z", - "expires_at": "2020-01-21T14:59:22Z", - "updated_at": "2020-01-21T14:59:22Z", - "digest": "sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c", - "workflow_run": { - "id": 2332938, - "repository_id": 1296269, - "head_repository_id": 1296269, - "head_branch": "main", - "head_sha": "328faa0536e6fef19753d9d91dc96a9931694ce3" + "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 } - } + ] } } } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "artifacts" - } - }, - "delete": { - "summary": "Delete an artifact", - "description": "Deletes an artifact for a workflow run.\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/delete-artifact", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/artifacts#delete-an-artifact" - }, - "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": "artifact_id", - "description": "The unique identifier of the artifact.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "artifacts" - } - } - }, - "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}": { - "get": { - "summary": "Download an artifact", - "description": "Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in\nthe response header to find the URL for the download. The `:archive_format` must be `zip`.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/download-artifact", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/artifacts#download-an-artifact" - }, - "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": "artifact_id", - "description": "The unique identifier of the artifact.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "archive_format", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "302": { - "description": "Response", + }, "headers": { - "Location": { - "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", + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", "schema": { "type": "string" } } } }, - "410": { - "description": "Gone", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -195484,986 +186777,131 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "artifacts" - } - } - }, - "/repos/{owner}/{repo}/actions/cache/usage": { - "get": { - "summary": "Get GitHub Actions cache usage for a repository", - "description": "Gets GitHub Actions cache usage for a repository.\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\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/get-actions-cache-usage", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-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", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Actions Cache Usage by repository", - "description": "GitHub Actions Cache Usage by repository.", + "title": "Validation Error", + "description": "Validation Error", "type": "object", - "properties": { - "full_name": { - "description": "The repository owner and name for the cache usage being shown.", - "type": "string", - "examples": [ - "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", - "examples": [ - 2322142 - ] - }, - "active_caches_count": { - "description": "The number of active caches in the repository.", - "type": "integer", - "examples": [ - 3 - ] - } - }, "required": [ - "full_name", - "active_caches_size_in_bytes", - "active_caches_count" - ] - }, - "examples": { - "default": { - "value": { - "full_name": "octo-org/Hello-World", - "active_caches_size_in_bytes": 2322142, - "active_caches_count": 3 - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "cache" - } - } - }, - "/repos/{owner}/{repo}/actions/caches": { - "get": { - "summary": "List GitHub Actions caches for a repository", - "description": "Lists the GitHub Actions caches for a repository.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/get-actions-cache-list", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/cache#list-github-actions-caches-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 - } - }, - { - "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 a pull request use `refs/pull//merge`.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "key", - "description": "An explicit key or prefix for identifying the cache", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "sort", - "description": "The property to sort the results by. `created_at` means when the cache was created. `last_accessed_at` means when the cache was last accessed. `size_in_bytes` is the size of the cache in bytes.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created_at", - "last_accessed_at", - "size_in_bytes" - ], - "default": "last_accessed_at" - } - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Repository actions caches", - "description": "Repository actions caches", - "type": "object", + "message", + "documentation_url" + ], "properties": { - "total_count": { - "description": "Total number of caches", - "type": "integer", - "examples": [ - 2 - ] + "message": { + "type": "string" }, - "actions_caches": { - "description": "Array of caches", + "documentation_url": { + "type": "string" + }, + "errors": { "type": "array", "items": { "type": "object", + "required": [ + "code" + ], "properties": { - "id": { - "type": "integer", - "examples": [ - 2 - ] - }, - "ref": { - "type": "string", - "examples": [ - "refs/heads/main" - ] + "resource": { + "type": "string" }, - "key": { - "type": "string", - "examples": [ - "Linux-node-958aff96db2d75d67787d1e634ae70b659de937b" - ] + "field": { + "type": "string" }, - "version": { - "type": "string", - "examples": [ - "73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0" - ] + "message": { + "type": "string" }, - "last_accessed_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2019-01-24T22:45:36.000Z" - ] + "code": { + "type": "string" }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2019-01-24T22:45:36.000Z" - ] + "index": { + "type": "integer" }, - "size_in_bytes": { - "type": "integer", - "examples": [ - 1024 + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } ] } } } } - }, - "required": [ - "total_count", - "actions_caches" - ] - }, - "examples": { - "default": { - "value": { - "total_count": 1, - "actions_caches": [ - { - "id": 505, - "ref": "refs/heads/main", - "key": "Linux-node-958aff96db2d75d67787d1e634ae70b659de937b", - "version": "73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0", - "last_accessed_at": "2019-01-24T22:45:36.000Z", - "created_at": "2019-01-24T22:45:36.000Z", - "size_in_bytes": 1024 - } - ] - } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [], - "category": "actions", - "subcategory": "cache" - } - }, - "delete": { - "summary": "Delete GitHub Actions caches for a repository (using a cache key)", - "description": "Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/delete-actions-cache-by-key", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key" - }, - "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": "key", - "description": "A key for identifying the cache.", - "in": "query", - "required": true, - "schema": { - "type": "string" - } + "304": { + "description": "Not modified" }, - { - "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 a pull request use `refs/pull//merge`.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "title": "Repository actions caches", - "description": "Repository actions caches", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "total_count": { - "description": "Total number of caches", - "type": "integer", - "examples": [ - 2 - ] + "message": { + "type": "string" }, - "actions_caches": { - "description": "Array of caches", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "examples": [ - 2 - ] - }, - "ref": { - "type": "string", - "examples": [ - "refs/heads/main" - ] - }, - "key": { - "type": "string", - "examples": [ - "Linux-node-958aff96db2d75d67787d1e634ae70b659de937b" - ] - }, - "version": { - "type": "string", - "examples": [ - "73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0" - ] - }, - "last_accessed_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2019-01-24T22:45:36.000Z" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2019-01-24T22:45:36.000Z" - ] - }, - "size_in_bytes": { - "type": "integer", - "examples": [ - 1024 - ] - } - } - } - } - }, - "required": [ - "total_count", - "actions_caches" - ] - }, - "examples": { - "default": { - "value": { - "total_count": 1, - "actions_caches": [ - { - "id": 505, - "ref": "refs/heads/main", - "key": "Linux-node-958aff96db2d75d67787d1e634ae70b659de937b", - "version": "73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0", - "last_accessed_at": "2019-01-24T22:45:36.000Z", - "created_at": "2019-01-24T22:45:36.000Z", - "size_in_bytes": 1024 - } - ] + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "cache" - } - } - }, - "/repos/{owner}/{repo}/actions/caches/{cache_id}": { - "delete": { - "summary": "Delete a GitHub Actions cache for a repository (using a cache ID)", - "description": "Deletes a GitHub Actions cache for a repository, using a cache ID.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/delete-actions-cache-by-id", - "externalDocs": { - "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": [ - { - "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": "cache_id", - "description": "The unique identifier of the GitHub Actions cache.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "cache" - } - } - }, - "/repos/{owner}/{repo}/actions/jobs/{job_id}": { - "get": { - "summary": "Get a job for a workflow run", - "description": "Gets a specific job in a workflow run.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/get-job-for-workflow-run", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run" - }, - "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": "job_id", - "description": "The unique identifier of the job.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", + "401": { + "description": "Requires authentication", "content": { "application/json": { "schema": { - "title": "Job", - "description": "Information of a job execution in a workflow run", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "id": { - "description": "The id of the job.", - "type": "integer", - "examples": [ - 21 - ] - }, - "run_id": { - "description": "The id of the associated workflow run.", - "type": "integer", - "examples": [ - 5 - ] - }, - "run_url": { - "type": "string", - "examples": [ - "https://api.github.com/repos/github/hello-world/actions/runs/5" - ] - }, - "run_attempt": { - "type": "integer", - "description": "Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run.", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDg6Q2hlY2tSdW40" - ] + "message": { + "type": "string" }, - "head_sha": { - "description": "The SHA of the commit that is being run.", - "type": "string", - "examples": [ - "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" - ] + "documentation_url": { + "type": "string" }, "url": { - "type": "string", - "examples": [ - "https://api.github.com/repos/github/hello-world/actions/jobs/21" - ] - }, - "html_url": { - "type": [ - "string", - "null" - ], - "examples": [ - "https://github.com/github/hello-world/runs/4" - ] + "type": "string" }, "status": { - "description": "The phase of the lifecycle that the job is currently in.", - "type": "string", - "enum": [ - "queued", - "in_progress", - "completed", - "waiting", - "requested", - "pending" - ], - "examples": [ - "queued" - ] - }, - "conclusion": { - "description": "The outcome of the job.", - "type": [ - "string", - "null" - ], - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "skipped", - "timed_out", - "action_required", - null - ], - "examples": [ - "success" - ] - }, - "created_at": { - "description": "The time that the job created, in ISO 8601 format.", - "format": "date-time", - "type": "string", - "examples": [ - "2019-08-08T08:00:00-07:00" - ] - }, - "started_at": { - "description": "The time that the job started, in ISO 8601 format.", - "format": "date-time", - "type": "string", - "examples": [ - "2019-08-08T08:00:00-07:00" - ] - }, - "completed_at": { - "description": "The time that the job finished, in ISO 8601 format.", - "format": "date-time", - "type": [ - "string", - "null" - ], - "examples": [ - "2019-08-08T08:00:00-07:00" - ] - }, - "name": { - "description": "The name of the job.", - "type": "string", - "examples": [ - "test-coverage" - ] - }, - "steps": { - "description": "Steps in this job.", - "type": "array", - "items": { - "type": "object", - "required": [ - "name", - "status", - "conclusion", - "number" - ], - "properties": { - "status": { - "description": "The phase of the lifecycle that the job is currently in.", - "type": "string", - "enum": [ - "queued", - "in_progress", - "completed" - ], - "examples": [ - "queued" - ] - }, - "conclusion": { - "description": "The outcome of the job.", - "type": [ - "string", - "null" - ], - "examples": [ - "success" - ] - }, - "name": { - "description": "The name of the job.", - "type": "string", - "examples": [ - "test-coverage" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "started_at": { - "description": "The time that the step started, in ISO 8601 format.", - "format": "date-time", - "type": [ - "string", - "null" - ], - "examples": [ - "2019-08-08T08:00:00-07:00" - ] - }, - "completed_at": { - "description": "The time that the job finished, in ISO 8601 format.", - "format": "date-time", - "type": [ - "string", - "null" - ], - "examples": [ - "2019-08-08T08:00:00-07:00" - ] - } - } - } - }, - "check_run_url": { - "type": "string", - "examples": [ - "https://api.github.com/repos/github/hello-world/check-runs/4" - ] - }, - "labels": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Labels for the workflow job. Specified by the \"runs_on\" attribute in the action's workflow file.", - "examples": [ - "self-hosted", - "foo", - "bar" - ] - }, - "runner_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", - "examples": [ - 1 - ] - }, - "runner_name": { - "type": [ - "string", - "null" - ], - "description": "The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", - "examples": [ - "my runner" - ] - }, - "runner_group_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", - "examples": [ - 2 - ] - }, - "runner_group_name": { - "type": [ - "string", - "null" - ], - "description": "The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", - "examples": [ - "my runner group" - ] - }, - "workflow_name": { - "type": [ - "string", - "null" - ], - "description": "The name of the workflow.", - "examples": [ - "Build" - ] - }, - "head_branch": { - "type": [ - "string", - "null" - ], - "description": "The name of the current branch.", - "examples": [ - "main" - ] - } - }, - "required": [ - "id", - "node_id", - "run_id", - "run_url", - "head_sha", - "workflow_name", - "head_branch", - "name", - "url", - "html_url", - "status", - "conclusion", - "started_at", - "completed_at", - "check_run_url", - "labels", - "runner_id", - "runner_name", - "runner_group_id", - "runner_group_name", - "created_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 399444496, - "run_id": 29679449, - "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449", - "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==", - "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0", - "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496", - "html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496", - "status": "completed", - "conclusion": "success", - "started_at": "2020-01-20T17:42:40Z", - "completed_at": "2020-01-20T17:44:39Z", - "name": "build", - "steps": [ - { - "name": "Set up job", - "status": "completed", - "conclusion": "success", - "number": 1, - "started_at": "2020-01-20T09:42:40.000-08:00", - "completed_at": "2020-01-20T09:42:41.000-08:00" - }, - { - "name": "Run actions/checkout@v2", - "status": "completed", - "conclusion": "success", - "number": 2, - "started_at": "2020-01-20T09:42:41.000-08:00", - "completed_at": "2020-01-20T09:42:45.000-08:00" - }, - { - "name": "Set up Ruby", - "status": "completed", - "conclusion": "success", - "number": 3, - "started_at": "2020-01-20T09:42:45.000-08:00", - "completed_at": "2020-01-20T09:42:45.000-08:00" - }, - { - "name": "Run actions/cache@v3", - "status": "completed", - "conclusion": "success", - "number": 4, - "started_at": "2020-01-20T09:42:45.000-08:00", - "completed_at": "2020-01-20T09:42:48.000-08:00" - }, - { - "name": "Install Bundler", - "status": "completed", - "conclusion": "success", - "number": 5, - "started_at": "2020-01-20T09:42:48.000-08:00", - "completed_at": "2020-01-20T09:42:52.000-08:00" - }, - { - "name": "Install Gems", - "status": "completed", - "conclusion": "success", - "number": 6, - "started_at": "2020-01-20T09:42:52.000-08:00", - "completed_at": "2020-01-20T09:42:53.000-08:00" - }, - { - "name": "Run Tests", - "status": "completed", - "conclusion": "success", - "number": 7, - "started_at": "2020-01-20T09:42:53.000-08:00", - "completed_at": "2020-01-20T09:42:59.000-08:00" - }, - { - "name": "Deploy to Heroku", - "status": "completed", - "conclusion": "success", - "number": 8, - "started_at": "2020-01-20T09:42:59.000-08:00", - "completed_at": "2020-01-20T09:44:39.000-08:00" - }, - { - "name": "Post actions/cache@v3", - "status": "completed", - "conclusion": "success", - "number": 16, - "started_at": "2020-01-20T09:44:39.000-08:00", - "completed_at": "2020-01-20T09:44:39.000-08:00" - }, - { - "name": "Complete job", - "status": "completed", - "conclusion": "success", - "number": 17, - "started_at": "2020-01-20T09:44:39.000-08:00", - "completed_at": "2020-01-20T09:44:39.000-08:00" - } - ], - "check_run_url": "https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496", - "labels": [ - "self-hosted", - "foo", - "bar" - ], - "runner_id": 1, - "runner_name": "my runner", - "runner_group_id": 2, - "runner_group_name": "my runner group", - "workflow_name": "CI", - "head_branch": "main" + "type": "string" } } } @@ -196474,112 +186912,44 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "workflow-jobs" - } - } - }, - "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs": { - "get": { - "summary": "Download job logs for a workflow run", - "description": "Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look\nfor `Location:` in the response header to find the URL for the download.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/download-job-logs-for-workflow-run", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run" - }, - "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": "job_id", - "description": "The unique identifier of the job.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "302": { - "description": "Response", - "headers": { - "Location": { - "example": "https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/jobs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D", - "schema": { - "type": "string" - } - } - } - } + "category": "projects-classic", + "subcategory": "collaborators", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "workflow-jobs" - } + "deprecated": true } }, - "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun": { - "post": { - "summary": "Re-run a job from a workflow run", - "description": "Re-run a job and its dependent jobs in a workflow run.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "/projects/{project_id}/collaborators/{username}": { + "put": { + "summary": "Add project collaborator", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ - "actions" + "projects-classic" ], - "operationId": "actions/re-run-job-for-workflow-run", + "operationId": "projects-classic/add-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run" + "url": "https://docs.github.com/rest/projects-classic/collaborators#add-project-collaborator" }, "parameters": [ { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", + "name": "project_id", + "description": "The unique identifier of the project.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } }, { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "name": "username", + "description": "The handle for the GitHub user account.", "in": "path", "required": true, "schema": { "type": "string" } - }, - { - "name": "job_id", - "description": "The unique identifier of the job.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "requestBody": { @@ -196592,43 +186962,38 @@ "null" ], "properties": { - "enable_debug_logging": { - "type": "boolean", - "default": false, - "description": "Whether to enable debug logging for the re-run." + "permission": { + "description": "The permission to grant the collaborator.", + "enum": [ + "read", + "write", + "admin" + ], + "default": "write", + "type": "string", + "examples": [ + "write" + ] } } }, "examples": { "default": { - "value": null + "summary": "Applying write permissions for the new collaborator", + "value": { + "permission": "write" + } } } } } }, "responses": { - "201": { - "description": "Response", - "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" }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -196652,90 +187017,87 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "workflow-runs" - } - } - }, - "/repos/{owner}/{repo}/actions/oidc/customization/sub": { - "get": { - "summary": "Get the customization template for an OIDC subject claim for a repository", - "description": "Gets the customization template for an OpenID Connect (OIDC) subject claim.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/get-custom-oidc-sub-claim-for-repo", - "externalDocs": { - "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": [ - { - "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": "Status response", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Actions OIDC subject customization for a repository", - "description": "Actions OIDC subject customization for a repository", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { - "use_default": { - "description": "Whether to use the default template or not. If `true`, the `include_claim_keys` field is ignored.", - "type": "boolean" + "message": { + "type": "string" }, - "include_claim_keys": { - "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.", + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } } } - }, - "required": [ - "use_default" - ] - }, - "examples": { - "default": { - "value": { - "use_default": false, - "include_claim_keys": [ - "repo", - "context" - ] - } } } } } }, - "400": { - "description": "Bad Request", + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -196757,53 +187119,11 @@ } } } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": [ - "string", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } } } }, - "404": { - "description": "Resource not found", + "401": { + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -196830,36 +187150,39 @@ } }, "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [], - "category": "actions", - "subcategory": "oidc" - } + "category": "projects-classic", + "subcategory": "collaborators", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true }, - "put": { - "summary": "Set the customization template for an OIDC subject claim for a repository", - "description": "Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "delete": { + "summary": "Remove user as a collaborator", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ - "actions" + "projects-classic" ], - "operationId": "actions/set-custom-oidc-sub-claim-for-repo", + "operationId": "projects-classic/remove-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository" + "url": "https://docs.github.com/rest/projects-classic/collaborators#remove-user-as-a-collaborator" }, "parameters": [ { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", + "name": "project_id", + "description": "The unique identifier of the project.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } }, { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "name": "username", + "description": "The handle for the GitHub user account.", "in": "path", "required": true, "schema": { @@ -196867,64 +187190,12 @@ } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "title": "Actions OIDC subject customization for a repository", - "description": "Actions OIDC subject customization for a repository", - "type": "object", - "required": [ - "use_default" - ], - "properties": { - "use_default": { - "description": "Whether to use the default template or not. If `true`, the `include_claim_keys` field is ignored.", - "type": "boolean" - }, - "include_claim_keys": { - "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "examples": { - "default": { - "value": { - "use_default": false, - "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 - } - } - } - } + "204": { + "description": "Response" + }, + "304": { + "description": "Not modified" }, "404": { "description": "Resource not found", @@ -196952,8 +187223,8 @@ } } }, - "400": { - "description": "Bad Request", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -196975,48 +187246,6 @@ } } } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": [ - "string", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } } } }, @@ -197025,8 +187254,8 @@ "content": { "application/json": { "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", + "title": "Validation Error", + "description": "Validation Error", "type": "object", "required": [ "message", @@ -197042,337 +187271,122 @@ "errors": { "type": "array", "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "previews": [], - "category": "actions", - "subcategory": "oidc" - } - } - }, - "/repos/{owner}/{repo}/actions/organization-secrets": { - "get": { - "summary": "List repository organization secrets", - "description": "Lists all organization secrets shared with a repository without revealing their encrypted\nvalues.\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 `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/list-repo-organization-secrets", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets" - }, - "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": "object", - "required": [ - "total_count", - "secrets" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "secrets": { - "type": "array", - "items": { - "title": "Actions Secret", - "description": "Set secrets for GitHub Actions.", "type": "object", + "required": [ + "code" + ], "properties": { - "name": { - "description": "The name of the secret.", - "type": "string", - "examples": [ - "SECRET_TOKEN" - ] + "resource": { + "type": "string" }, - "created_at": { - "type": "string", - "format": "date-time" + "field": { + "type": "string" }, - "updated_at": { - "type": "string", - "format": "date-time" + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] } - }, - "required": [ - "name", - "created_at", - "updated_at" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 2, - "secrets": [ - { - "name": "GH_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z" - }, - { - "name": "GIST_ID", - "created_at": "2020-01-10T10:59:22Z", - "updated_at": "2020-01-11T11:59:22Z" } - ] + } } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - } - } - }, - "/repos/{owner}/{repo}/actions/organization-variables": { - "get": { - "summary": "List repository organization variables", - "description": "Lists all organization variables shared with a repository.\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 `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/list-repo-organization-variables", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/variables#list-repository-organization-variables" - }, - "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 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", + "401": { + "description": "Requires authentication", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "required": [ - "total_count", - "variables" - ], "properties": { - "total_count": { - "type": "integer" + "message": { + "type": "string" }, - "variables": { - "type": "array", - "items": { - "title": "Actions Variable", - "type": "object", - "properties": { - "name": { - "description": "The name of the variable.", - "type": "string", - "examples": [ - "USERNAME" - ] - }, - "value": { - "description": "The value of the variable.", - "type": "string", - "examples": [ - "octocat" - ] - }, - "created_at": { - "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time", - "examples": [ - "2019-01-24T22:45:36.000Z" - ] - }, - "updated_at": { - "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time", - "examples": [ - "2019-01-24T22:45:36.000Z" - ] - } - }, - "required": [ - "name", - "value", - "created_at", - "updated_at" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 2, - "variables": [ - { - "name": "USERNAME", - "value": "octocat", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z" - }, - { - "name": "EMAIL", - "value": "octocat@github.com", - "created_at": "2020-01-10T10:59:22Z", - "updated_at": "2020-01-11T11:59:22Z" - } - ] + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - } + "category": "projects-classic", + "subcategory": "collaborators", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true } }, - "/repos/{owner}/{repo}/actions/permissions": { + "/projects/{project_id}/collaborators/{username}/permission": { "get": { - "summary": "Get GitHub Actions permissions for a repository", - "description": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "operationId": "actions/get-github-actions-permissions-repository", + "summary": "Get project permission for a user", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ - "actions" + "projects-classic" ], + "operationId": "projects-classic/get-permission-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository" + "url": "https://docs.github.com/rest/projects-classic/collaborators#get-project-permission-for-a-user" }, "parameters": [ { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", + "name": "project_id", + "description": "The unique identifier of the project.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } }, { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "name": "username", + "description": "The handle for the GitHub user account.", "in": "path", "required": true, "schema": { @@ -197386,506 +187400,374 @@ "content": { "application/json": { "schema": { + "title": "Project Collaborator Permission", + "description": "Project Collaborator Permission", "type": "object", "properties": { - "enabled": { - "type": "boolean", - "description": "Whether GitHub Actions is enabled on the repository." + "permission": { + "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" + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } ] - }, - "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" + "permission", + "user" ] }, "examples": { "default": { "value": { - "enabled": true, - "allowed_actions": "selected", - "selected_actions_url": "https://api.github.com/repositories/42/actions/permissions/selected-actions" + "permission": "admin", + "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 + } } } } } } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "githubCloudOnly": false, - "category": "actions", - "subcategory": "permissions" - } - }, - "put": { - "summary": "Set GitHub Actions permissions for a repository", - "description": "Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "operationId": "actions/set-github-actions-permissions-repository", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#set-github-actions-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" - } - }, - "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", + "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" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [], - "category": "actions", - "subcategory": "permissions" - } - } - }, - "/repos/{owner}/{repo}/actions/permissions/selected-actions": { - "get": { - "summary": "Get allowed actions and reusable workflows for a repository", - "description": "Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "operationId": "actions/get-allowed-actions-repository", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-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", + "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": { - "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": { + "errors": { "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" + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } } } } - }, - "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 a repository", - "description": "Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "operationId": "actions/set-allowed-actions-repository", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-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" - } - }, - "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": { + "304": { + "description": "Not modified" + }, + "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": { - "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" - } - } - }, - "/repos/{owner}/{repo}/actions/permissions/workflow": { - "get": { - "summary": "Get default workflow permissions for a repository", - "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository,\nas well as if GitHub Actions can submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/get-github-actions-default-workflow-permissions-repository", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#get-default-workflow-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", + "401": { + "description": "Requires authentication", "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" } } } @@ -197896,127 +187778,34 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - }, - "put": { - "summary": "Set default workflow permissions for a repository", - "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions\ncan submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/set-github-actions-default-workflow-permissions-repository", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#set-default-workflow-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": "Success response" - }, - "409": { - "description": "Conflict response when changing a setting is prevented by the owning organization" - } - }, - "requestBody": { - "required": true, - "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 - } - } - } - } - } + "category": "projects-classic", + "subcategory": "collaborators", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } + "deprecated": true } }, - "/repos/{owner}/{repo}/actions/runners": { + "/projects/{project_id}/columns": { "get": { - "summary": "List self-hosted runners for a repository", - "description": "Lists all self-hosted runners configured in a repository.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "summary": "List project columns", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ - "actions" + "projects-classic" ], - "operationId": "actions/list-self-hosted-runners-for-repo", + "operationId": "projects-classic/list-columns", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-a-repository" + "url": "https://docs.github.com/rest/projects-classic/columns#list-project-columns" }, "parameters": [ { - "name": "name", - "description": "The name of a self-hosted runner.", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "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.", + "name": "project_id", + "description": "The unique identifier of the project.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } }, { @@ -198044,167 +187833,94 @@ "content": { "application/json": { "schema": { - "type": "object", - "required": [ - "total_count", - "runners" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "runners": { - "type": "array", - "items": { - "title": "Self hosted runners", - "description": "A self hosted runner", - "type": "object", - "properties": { - "id": { - "description": "The ID of the runner.", - "type": "integer", - "examples": [ - 5 - ] - }, - "runner_group_id": { - "description": "The ID of the runner group.", - "type": "integer", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the runner.", - "type": "string", - "examples": [ - "iMac" - ] - }, - "os": { - "description": "The Operating System of the runner.", - "type": "string", - "examples": [ - "macos" - ] - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "examples": [ - "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" + "type": "array", + "items": { + "title": "Project Column", + "description": "Project columns contain cards of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" + ] + }, + "project_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/120" + ] + }, + "cards_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367/cards" + ] + }, + "id": { + "description": "The unique identifier of the project column", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEzOlByb2plY3RDb2x1bW4zNjc=" + ] + }, + "name": { + "description": "Name of the project column", + "type": "string", + "examples": [ + "Remaining tasks" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:18:44Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:22:28Z" ] } - } + }, + "required": [ + "id", + "node_id", + "url", + "project_url", + "cards_url", + "name", + "created_at", + "updated_at" + ] } }, "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" - } - ] - } - ] - } + "value": [ + { + "url": "https://api.github.com/projects/columns/367", + "project_url": "https://api.github.com/projects/120", + "cards_url": "https://api.github.com/projects/columns/367/cards", + "id": 367, + "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", + "name": "To Do", + "created_at": "2016-09-05T14:18:44Z", + "updated_at": "2016-09-05T14:22:28Z" + } + ] } } } @@ -198217,122 +187933,57 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "self-hosted-runners" - } - } - }, - "/repos/{owner}/{repo}/actions/runners/downloads": { - "get": { - "summary": "List runner applications for a repository", - "description": "Lists binaries for the runner application that you can download and run.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/list-runner-applications-for-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-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", + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", "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": { - "type": "string" - } + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "required": [ - "os", - "architecture", - "download_url", - "filename" - ] + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } } - }, - "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" - } - ] + } + } + } + }, + "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" + } } } } @@ -198342,40 +187993,32 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "self-hosted-runners" - } - } - }, - "/repos/{owner}/{repo}/actions/runners/generate-jitconfig": { + "category": "projects-classic", + "subcategory": "columns", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true + }, "post": { - "summary": "Create configuration for a just-in-time runner for a repository", - "description": "Generates a configuration that can be passed to the runner application at startup.\n\nThe authenticated user must have admin access to the repository.\n\nOAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint.", + "summary": "Create a project column", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ - "actions" + "projects-classic" ], - "operationId": "actions/generate-runner-jitconfig-for-repo", + "operationId": "projects-classic/create-column", "externalDocs": { "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" + "url": "https://docs.github.com/rest/projects-classic/columns#create-a-project-column" }, "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.", + "name": "project_id", + "description": "The unique identifier of the project.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], @@ -198384,49 +188027,24 @@ "content": { "application/json": { "schema": { - "type": "object", - "required": [ - "name", - "runner_group_id", - "labels" - ], "properties": { "name": { + "description": "Name of the project column", "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": { - "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" + "examples": [ + "Remaining tasks" + ] } - } + }, + "required": [ + "name" + ], + "type": "object" }, "examples": { "default": { "value": { - "name": "New runner", - "runner_group_id": 1, - "labels": [ - "self-hosted", - "X64", - "macOS", - "no-gpu" - ], - "work_folder": "_work" + "name": "Remaining tasks" } } } @@ -198439,144 +188057,99 @@ "content": { "application/json": { "schema": { + "title": "Project Column", + "description": "Project columns contain cards of work.", "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", - "examples": [ - 5 - ] - }, - "runner_group_id": { - "description": "The ID of the runner group.", - "type": "integer", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the runner.", - "type": "string", - "examples": [ - "iMac" - ] - }, - "os": { - "description": "The Operating System of the runner.", - "type": "string", - "examples": [ - "macos" - ] - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "examples": [ - "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" + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" ] }, - "encoded_jit_config": { + "project_url": { "type": "string", - "description": "The base64 encoded runner configuration." + "format": "uri", + "examples": [ + "https://api.github.com/projects/120" + ] + }, + "cards_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367/cards" + ] + }, + "id": { + "description": "The unique identifier of the project column", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEzOlByb2plY3RDb2x1bW4zNjc=" + ] + }, + "name": { + "description": "Name of the project column", + "type": "string", + "examples": [ + "Remaining tasks" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:18:44Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:22:28Z" + ] } - } + }, + "required": [ + "id", + "node_id", + "url", + "project_url", + "cards_url", + "name", + "created_at", + "updated_at" + ] }, "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" + "url": "https://api.github.com/projects/columns/367", + "project_url": "https://api.github.com/projects/120", + "cards_url": "https://api.github.com/projects/columns/367/cards", + "id": 367, + "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", + "name": "To Do", + "created_at": "2016-09-05T14:18:44Z", + "updated_at": "2016-09-05T14:22:28Z" } } } } } }, - "404": { - "description": "Resource not found", + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -198631,8 +188204,8 @@ } } }, - "409": { - "description": "Conflict", + "401": { + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -198661,1058 +188234,491 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "self-hosted-runners" - } + "category": "projects-classic", + "subcategory": "columns", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true } }, - "/repos/{owner}/{repo}/actions/runners/registration-token": { - "post": { - "summary": "Create a registration token for a repository", - "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 repository to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "/rate_limit": { + "get": { + "summary": "Get rate limit status for the authenticated user", + "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners).\"\n* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", "tags": [ - "actions" + "rate-limit" ], - "operationId": "actions/create-registration-token-for-repo", + "operationId": "rate-limit/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository" + "url": "https://docs.github.com/rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user" }, - "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" - } - } - ], + "parameters": [], "responses": { - "201": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Authentication Token", - "description": "Authentication Token", + "title": "Rate Limit Overview", + "description": "Rate Limit Overview", "type": "object", "properties": { - "token": { - "description": "The token used for authentication", - "type": "string", - "examples": [ - "v1.1f699f1069f60xxx" - ] - }, - "expires_at": { - "description": "The time this token expires", - "type": "string", - "format": "date-time", - "examples": [ - "2016-07-11T22:14:10Z" - ] - }, - "permissions": { + "resources": { "type": "object", - "examples": [ - { - "issues": "read", - "deployments": "write" - } - ] - }, - "repositories": { - "description": "The repositories this token has access to", - "type": "array", - "items": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] + "properties": { + "core": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "graphql": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "search": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "code_search": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + "remaining": { + "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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" } }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "source_import": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } }, - "open_issues": { - "type": "integer" + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "integration_manifest": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } }, - "watchers": { - "type": "integer" + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "code_scanning_upload": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } }, - "master_branch": { - "type": "string" + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "actions_runner_registration": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "scim": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "dependency_snapshots": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } }, - "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": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "dependency_sbom": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" } - } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] }, - "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" - ] - } - }, - "single_file": { - "type": [ - "string", - "null" - ], - "examples": [ - "config.yaml" + "code_scanning_autofix": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + } + }, + "required": [ + "core", + "search" ] }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" + "rate": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" ] } }, "required": [ - "token", - "expires_at" + "rate", + "resources" ] }, "examples": { "default": { "value": { - "token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6", - "expires_at": "2020-01-22T12:13:35.123-08:00" + "resources": { + "core": { + "limit": 5000, + "used": 1, + "remaining": 4999, + "reset": 1691591363 + }, + "search": { + "limit": 30, + "used": 12, + "remaining": 18, + "reset": 1691591091 + }, + "graphql": { + "limit": 5000, + "used": 7, + "remaining": 4993, + "reset": 1691593228 + }, + "integration_manifest": { + "limit": 5000, + "used": 1, + "remaining": 4999, + "reset": 1691594631 + }, + "source_import": { + "limit": 100, + "used": 1, + "remaining": 99, + "reset": 1691591091 + }, + "code_scanning_upload": { + "limit": 500, + "used": 1, + "remaining": 499, + "reset": 1691594631 + }, + "actions_runner_registration": { + "limit": 10000, + "used": 0, + "remaining": 10000, + "reset": 1691594631 + }, + "scim": { + "limit": 15000, + "used": 0, + "remaining": 15000, + "reset": 1691594631 + }, + "dependency_snapshots": { + "limit": 100, + "used": 0, + "remaining": 100, + "reset": 1691591091 + }, + "code_search": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 + }, + "code_scanning_autofix": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 + } + }, + "rate": { + "limit": 5000, + "used": 1, + "remaining": 4999, + "reset": 1372700873 + } + } + } + } + } + }, + "headers": { + "X-RateLimit-Limit": { + "example": 5000, + "schema": { + "type": "integer" + } + }, + "X-RateLimit-Remaining": { + "example": 4999, + "schema": { + "type": "integer" + } + }, + "X-RateLimit-Reset": { + "example": 1590701888, + "schema": { + "type": "integer", + "format": "timestamp" + } + } + } + }, + "304": { + "description": "Not modified" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } @@ -199723,22 +188729,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "self-hosted-runners" + "category": "rate-limit", + "subcategory": "rate-limit" } } }, - "/repos/{owner}/{repo}/actions/runners/remove-token": { - "post": { - "summary": "Create a remove token for a repository", - "description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. 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 repository to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "/repos/{owner}/{repo}": { + "get": { + "summary": "Get a repository", + "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n> [!NOTE]\n> In order to see the `security_and_analysis` block for a repository 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).\"", "tags": [ - "actions" + "repos" ], - "operationId": "actions/create-remove-token-for-repo", + "operationId": "repos/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository" + "url": "https://docs.github.com/rest/repos/repos#get-a-repository" }, "parameters": [ { @@ -199761,2969 +188767,18650 @@ } ], "responses": { - "201": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Authentication Token", - "description": "Authentication Token", + "title": "Full Repository", + "description": "Full Repository", "type": "object", "properties": { - "token": { - "description": "The token used for authentication", + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] + }, + "node_id": { "type": "string", "examples": [ - "v1.1f699f1069f60xxx" + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "expires_at": { - "description": "The time this token expires", + "name": { "type": "string", - "format": "date-time", "examples": [ - "2016-07-11T22:14:10Z" + "Hello-World" ] }, - "permissions": { - "type": "object", + "full_name": { + "type": "string", "examples": [ - { - "issues": "read", - "deployments": "write" + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, - "repositories": { - "description": "The repositories this token has access to", + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { "type": "array", "items": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] - } - }, - "single_file": { - "type": [ - "string", - "null" - ], + "type": "string" + }, "examples": [ - "config.yaml" + "octocat", + "atom", + "electron", + "API" ] }, - "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" - } - } - }, - "/repos/{owner}/{repo}/actions/runners/{runner_id}": { - "get": { - "summary": "Get a self-hosted runner for a repository", - "description": "Gets a specific self-hosted runner configured in a repository.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/get-self-hosted-runner-for-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-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": "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", + "has_issues": { + "type": "boolean", "examples": [ - 5 + true ] }, - "runner_group_id": { - "description": "The ID of the runner group.", - "type": "integer", + "has_projects": { + "type": "boolean", "examples": [ - 1 + true ] }, - "name": { - "description": "The name of the runner.", - "type": "string", + "has_wiki": { + "type": "boolean", "examples": [ - "iMac" + true ] }, - "os": { - "description": "The Operating System of the runner.", - "type": "string", + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean", "examples": [ - "macos" + true ] }, - "status": { - "description": "The status of the runner.", - "type": "string", + "has_discussions": { + "type": "boolean", "examples": [ - "online" + true ] }, - "busy": { + "archived": { "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" - ] - } + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." }, - "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" - }, - { - "id": 21, - "name": "no-gpu", - "type": "custom" - } + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "type": "string", + "examples": [ + "public" ] - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "self-hosted-runners" - } - }, - "delete": { - "summary": "Delete a self-hosted runner from a repository", - "description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/delete-self-hosted-runner-from-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-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": "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" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "self-hosted-runners" - } - } - }, - "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels": { - "get": { - "summary": "List labels for a self-hosted runner for a repository", - "description": "Lists all labels for a self-hosted runner configured in a repository.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/list-labels-for-self-hosted-runner-for-repo", - "externalDocs": { - "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": [ - { - "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": "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": { - "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" - } + "pushed_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" ] - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/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": "self-hosted-runners" - } - }, - "post": { - "summary": "Add custom labels to a self-hosted runner for a repository", - "description": "Adds custom labels to a self-hosted runner configured in a repository.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/add-custom-labels-to-self-hosted-runner-for-repo", - "externalDocs": { - "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": [ - { - "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": "runner_id", - "description": "Unique identifier of the self-hosted runner.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "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": { - "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" - } + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" ] - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/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": "actions", - "subcategory": "self-hosted-runners" - } - }, - "put": { - "summary": "Set custom labels for a self-hosted runner for a repository", - "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/set-custom-labels-for-self-hosted-runner-for-repo", - "externalDocs": { - "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": [ - { - "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": "runner_id", - "description": "Unique identifier of the self-hosted runner.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "labels" - ], - "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": { - "default": { - "value": { - "labels": [ - "gpu", - "accelerated" - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "labels" - ], - "properties": { - "total_count": { - "type": "integer" + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] }, - "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" - ] - } + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" }, - "required": [ - "name" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 4, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" + "maintain": { + "type": "boolean" }, - { - "id": 7, - "name": "X64", - "type": "read-only" + "push": { + "type": "boolean" }, - { - "id": 20, - "name": "macOS", - "type": "read-only" + "triage": { + "type": "boolean" }, - { - "id": 21, - "name": "no-gpu", - "type": "custom" + "pull": { + "type": "boolean" } + }, + "required": [ + "admin", + "pull", + "push" ] - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/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": "actions", - "subcategory": "self-hosted-runners" - } - }, - "delete": { - "summary": "Remove all custom labels from a self-hosted runner for a repository", - "description": "Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/remove-all-custom-labels-from-self-hosted-runner-for-repo", - "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-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": "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": { - "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" - } + "allow_rebase_merge": { + "type": "boolean", + "examples": [ + 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": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "self-hosted-runners" - } - } - }, - "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}": { - "delete": { - "summary": "Remove a custom label from a self-hosted runner for a repository", - "description": "Remove a custom label from a self-hosted runner configured\nin a repository. 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 repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/remove-custom-label-from-self-hosted-runner-for-repo", - "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-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": "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", - "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" - }, + "template_repository": { + "anyOf": [ { - "id": 20, - "name": "macOS", - "type": "read-only" + "type": "null" }, { - "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" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "self-hosted-runners" - } - } - }, - "/repos/{owner}/{repo}/actions/runs": { - "get": { - "summary": "List workflow runs for a repository", - "description": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.\n\nThis endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.", - "tags": [ - "actions" - ], - "operationId": "actions/list-workflow-runs-for-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-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": "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.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "Returns workflow runs associated with a branch. Use the name of the branch of the `push`.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "event", - "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "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 can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "completed", - "action_required", - "cancelled", - "failure", - "neutral", - "skipped", - "stale", - "success", - "timed_out", - "in_progress", - "queued", - "requested", - "waiting", - "pending" - ] - } - }, - { - "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": "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).\"", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "exclude_pull_requests", - "description": "If `true` pull requests are omitted from the response (empty array).", - "in": "query", - "required": false, - "schema": { - "type": "boolean", - "default": false - } - }, - { - "name": "check_suite_id", - "description": "Returns workflow runs with the `check_suite_id` that you specify.", - "in": "query", - "schema": { - "type": "integer" - } - }, - { - "name": "head_sha", - "description": "Only returns workflow runs that are associated with the specified `head_sha`.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "workflow_runs" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "workflow_runs": { - "type": "array", - "items": { - "title": "Workflow Run", - "description": "An invocation of a workflow", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the workflow run.", - "examples": [ - 5 - ] - }, - "name": { - "type": [ - "string", - "null" - ], - "description": "The name of the workflow run.", - "examples": [ - "Build" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOkNoZWNrU3VpdGU1" - ] - }, - "check_suite_id": { - "type": "integer", - "description": "The ID of the associated check suite.", - "examples": [ - 42 - ] - }, - "check_suite_node_id": { - "type": "string", - "description": "The node ID of the associated check suite.", - "examples": [ - "MDEwOkNoZWNrU3VpdGU0Mg==" - ] - }, - "head_branch": { - "type": [ - "string", - "null" - ], - "examples": [ - "master" - ] - }, - "head_sha": { - "description": "The SHA of the head commit that points to the version of the workflow being run.", - "type": "string", - "examples": [ - "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" - ] - }, - "path": { - "description": "The full path of the workflow", - "type": "string", - "examples": [ - "octocat/octo-repo/.github/workflows/ci.yml@main" - ] - }, - "run_number": { - "type": "integer", - "description": "The auto incrementing run number for the workflow run.", - "examples": [ - 106 - ] - }, - "run_attempt": { - "type": "integer", - "description": "Attempt number of the run, 1 for first attempt and higher if the workflow was re-run.", - "examples": [ - 1 - ] - }, - "referenced_workflows": { - "type": [ - "array", - "null" - ], - "items": { - "title": "Referenced workflow", - "description": "A workflow referenced/reused by the initial caller workflow", + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { "type": "object", "properties": { - "path": { - "type": "string" + "admin": { + "type": "boolean" }, - "sha": { - "type": "string" + "pull": { + "type": "boolean" }, - "ref": { - "type": "string" + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" } }, "required": [ - "path", - "sha" + "admin", + "pull", + "push" ] - } - }, - "event": { - "type": "string", - "examples": [ - "push" - ] - }, - "status": { - "type": [ - "string", - "null" - ], - "examples": [ - "completed" - ] - }, - "conclusion": { - "type": [ - "string", - "null" - ], - "examples": [ - "neutral" - ] - }, - "workflow_id": { - "type": "integer", - "description": "The ID of the parent workflow.", - "examples": [ - 5 - ] - }, - "url": { - "type": "string", - "description": "The URL to the workflow run.", - "examples": [ - "https://api.github.com/repos/github/hello-world/actions/runs/5" - ] - }, - "html_url": { - "type": "string", - "examples": [ - "https://github.com/github/hello-world/suites/4" - ] - }, - "pull_requests": { - "description": "Pull requests that are open with a `head_sha` or `head_branch` that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run.", - "type": [ - "array", - "null" - ], - "items": { - "title": "Pull Request Minimal", + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, "id": { "type": "integer", - "format": "int64" + "format": "int64", + "examples": [ + 1 + ] }, - "number": { - "type": "integer" + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] }, "url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] }, - "head": { - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "repo": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "name" - ] - } - }, - "required": [ - "ref", - "sha", - "repo" + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" ] }, - "base": { - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "repo": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "name" - ] - } - }, - "required": [ - "ref", - "sha", - "repo" + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", "id", - "number", - "url", - "head", - "base" + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } } }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" + "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" + ] + } + ] + }, + "temp_clone_token": { + "type": [ + "string", + "null" + ] + }, + "allow_squash_merge": { + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "type": "boolean", + "examples": [ + false + ] + }, + "allow_merge_commit": { + "type": "boolean", + "examples": [ + true + ] + }, + "allow_update_branch": { + "type": "boolean", + "examples": [ + true + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "examples": [ + false + ] + }, + "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).", + "examples": [ + "PR_TITLE" + ] + }, + "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.", + "examples": [ + "PR_BODY" + ] + }, + "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).", + "examples": [ + "PR_TITLE" + ] + }, + "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.", + "examples": [ + "PR_BODY" + ] + }, + "allow_forking": { + "type": "boolean", + "examples": [ + true + ] + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "subscribers_count": { + "type": "integer", + "examples": [ + 42 + ] + }, + "network_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } }, - "actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - "triggering_actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "parent": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "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" + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "source": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "forks": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "anonymous_access_enabled": { + "description": "Whether anonymous git access is allowed.", + "default": true, + "type": "boolean" + }, + "code_of_conduct": { + "title": "Code Of Conduct Simple", + "description": "Code of Conduct Simple", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/github/docs/community/code_of_conduct" + ] + }, + "key": { + "type": "string", + "examples": [ + "citizen_code_of_conduct" + ] + }, + "name": { + "type": "string", + "examples": [ + "Citizen Code of Conduct" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md" + ] + } + }, + "required": [ + "url", + "key", + "name", + "html_url" + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "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", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "has_discussions", + "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", + "network_count", + "subscribers_count" + ] + }, + "examples": { + "default-response": { + "summary": "Default response", + "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}", + "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", + "forks_count": 9, + "forks": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "open_issues": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "has_discussions": false, + "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": { + "pull": true, + "push": false, + "admin": false + }, + "allow_rebase_merge": true, + "template_repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World-Template", + "full_name": "octocat/Hello-World-Template", + "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-Template", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World-Template", + "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World-Template.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World-Template.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World-Template.git", + "mirror_url": "git:git.example.com/octocat/Hello-World-Template", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World-Template", + "homepage": "https://github.com", + "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, + "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", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "allow_forking": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "spdx_id": "MIT", + "url": "https://api.github.com/licenses/mit", + "node_id": "MDc6TGljZW5zZW1pdA==" + }, + "organization": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "Organization", + "site_admin": false + }, + "parent": { + "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, + "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://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + }, + "source": { + "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", + "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, + "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://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1, + "security_and_analysis": { + "advanced_security": { + "status": "enabled" + }, + "secret_scanning": { + "status": "enabled" + }, + "secret_scanning_push_protection": { + "status": "disabled" + }, + "secret_scanning_non_provider_patterns": { + "status": "disabled" + } + } + } + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "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" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + } + }, + "patch": { + "summary": "Update a repository", + "description": "**Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/repos/repos#replace-all-repository-topics) endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/update", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#update-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": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository." + }, + "description": { + "type": "string", + "description": "A short description of the repository." + }, + "homepage": { + "type": "string", + "description": "A URL with more information about the repository." + }, + "private": { + "type": "boolean", + "description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", + "default": false + }, + "visibility": { + "type": "string", + "description": "The visibility of the repository.", + "enum": [ + "public", + "private" + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "description": "Specify which security and analysis features to enable or disable for the repository.\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\nFor example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request:\n`{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }`.\n\nYou can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request.", + "properties": { + "advanced_security": { + "type": "object", + "description": "Use the `status` property to enable or disable GitHub Advanced Security for this repository.\nFor more information, see \"[About GitHub Advanced\nSecurity](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.", + "properties": { + "status": { + "type": "string", + "description": "Can be `enabled` or `disabled`." + } + } + }, + "code_security": { + "type": "object", + "description": "Use the `status` property to enable or disable GitHub Code Security for this repository.", + "properties": { + "status": { + "type": "string", + "description": "Can be `enabled` or `disabled`." + } + } + }, + "secret_scanning": { + "type": "object", + "description": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", + "properties": { + "status": { + "type": "string", + "description": "Can be `enabled` or `disabled`." + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "description": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"", + "properties": { + "status": { + "type": "string", + "description": "Can be `enabled` or `disabled`." + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "description": "Use the `status` property to enable or disable secret scanning AI detection for this repository. For more information, see \"[Responsible detection of generic secrets with AI](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/generic-secret-detection/responsible-ai-generic-secrets).\"", + "properties": { + "status": { + "type": "string", + "description": "Can be `enabled` or `disabled`." + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "description": "Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. For more information, see \"[Supported secret scanning patterns](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"", + "properties": { + "status": { + "type": "string", + "description": "Can be `enabled` or `disabled`." + } + } + } + } + }, + "has_issues": { + "type": "boolean", + "description": "Either `true` to enable issues for this repository or `false` to disable them.", + "default": true + }, + "has_projects": { + "type": "boolean", + "description": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", + "default": true + }, + "has_wiki": { + "type": "boolean", + "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", + "default": true + }, + "is_template": { + "type": "boolean", + "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", + "default": false + }, + "default_branch": { + "type": "string", + "description": "Updates the default branch for this repository." + }, + "allow_squash_merge": { + "type": "boolean", + "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", + "default": true + }, + "allow_merge_commit": { + "type": "boolean", + "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", + "default": true + }, + "allow_rebase_merge": { + "type": "boolean", + "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", + "default": true + }, + "allow_auto_merge": { + "type": "boolean", + "description": "Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge.", + "default": false + }, + "delete_branch_on_merge": { + "type": "boolean", + "description": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", + "default": false + }, + "allow_update_branch": { + "type": "boolean", + "description": "Either `true` to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise.", + "default": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **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": "Required when using `squash_merge_commit_message`.\n\nThe 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": "Required when using `merge_commit_message`.\n\nThe 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." + }, + "archived": { + "type": "boolean", + "description": "Whether to archive this repository. `false` will unarchive a previously archived repository.", + "default": false + }, + "allow_forking": { + "type": "boolean", + "description": "Either `true` to allow private forks, or `false` to prevent private forks.", + "default": false + }, + "web_commit_signoff_required": { + "type": "boolean", + "description": "Either `true` to require contributors to sign off on web-based commits, or `false` to not require contributors to sign off on web-based commits.", + "default": false + } + } + }, + "examples": { + "default": { + "value": { + "name": "Hello-World", + "description": "This is your first repository", + "homepage": "https://github.com", + "private": true, + "has_issues": true, + "has_projects": true, + "has_wiki": true + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Full Repository", + "description": "Full Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "octocat", + "atom", + "electron", + "API" + ] + }, + "has_issues": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "type": "string", + "examples": [ + "public" + ] + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "allow_rebase_merge": { + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + } + ] + }, + "temp_clone_token": { + "type": [ + "string", + "null" + ] + }, + "allow_squash_merge": { + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "type": "boolean", + "examples": [ + false + ] + }, + "allow_merge_commit": { + "type": "boolean", + "examples": [ + true + ] + }, + "allow_update_branch": { + "type": "boolean", + "examples": [ + true + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "examples": [ + false + ] + }, + "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).", + "examples": [ + "PR_TITLE" + ] + }, + "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.", + "examples": [ + "PR_BODY" + ] + }, + "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).", + "examples": [ + "PR_TITLE" + ] + }, + "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.", + "examples": [ + "PR_BODY" + ] + }, + "allow_forking": { + "type": "boolean", + "examples": [ + true + ] + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "subscribers_count": { + "type": "integer", + "examples": [ + 42 + ] + }, + "network_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "parent": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "source": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "forks": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "anonymous_access_enabled": { + "description": "Whether anonymous git access is allowed.", + "default": true, + "type": "boolean" + }, + "code_of_conduct": { + "title": "Code Of Conduct Simple", + "description": "Code of Conduct Simple", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/github/docs/community/code_of_conduct" + ] + }, + "key": { + "type": "string", + "examples": [ + "citizen_code_of_conduct" + ] + }, + "name": { + "type": "string", + "examples": [ + "Citizen Code of Conduct" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md" + ] + } + }, + "required": [ + "url", + "key", + "name", + "html_url" + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "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", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "has_discussions", + "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", + "network_count", + "subscribers_count" + ] + }, + "examples": { + "default": { + "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}", + "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", + "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" + }, + "language": null, + "forks_count": 9, + "forks": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "open_issues": 0, + "is_template": false, + "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": { + "pull": true, + "push": false, + "admin": false + }, + "allow_rebase_merge": true, + "template_repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World-Template", + "full_name": "octocat/Hello-World-Template", + "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-Template", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World-Template", + "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World-Template.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World-Template.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World-Template.git", + "mirror_url": "git:git.example.com/octocat/Hello-World-Template", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World-Template", + "homepage": "https://github.com", + "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, + "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", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "allow_forking": true, + "web_commit_signoff_required": false, + "subscribers_count": 42, + "network_count": 0, + "organization": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "Organization", + "site_admin": false + }, + "parent": { + "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, + "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://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + }, + "source": { + "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, + "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://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + } + } + } + } + } + }, + "307": { + "description": "Temporary Redirect", + "content": { + "application/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" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/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": "repos", + "subcategory": "repos" + } + }, + "delete": { + "summary": "Delete a repository", + "description": "Deleting a repository requires admin access.\n\nIf an organization owner has configured the organization to prevent members from deleting organization-owned\nrepositories, you will get a `403 Forbidden` response.\n\nOAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/delete", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#delete-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" + }, + "403": { + "description": "If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response:", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Organization members cannot delete repositories.", + "documentation_url": "https://docs.github.com/rest/repos/repos#delete-a-repository" + } + } + } + } + } + }, + "307": { + "description": "Temporary Redirect", + "content": { + "application/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" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + } + } + }, + "/repos/{owner}/{repo}/actions/artifacts": { + "get": { + "summary": "List artifacts for a repository", + "description": "Lists all artifacts for a repository.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "actions" + ], + "operationId": "actions/list-artifacts-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/artifacts#list-artifacts-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 + } + }, + { + "name": "name", + "description": "The name field of an artifact. When specified, only artifacts with this name will be returned.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "artifacts" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "artifacts": { + "type": "array", + "items": { + "title": "Artifact", + "description": "An artifact", + "type": "object", + "properties": { + "id": { + "type": "integer", + "examples": [ + 5 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOkNoZWNrU3VpdGU1" + ] + }, + "name": { + "description": "The name of the artifact.", + "type": "string", + "examples": [ + "AdventureWorks.Framework" + ] + }, + "size_in_bytes": { + "description": "The size in bytes of the artifact.", + "type": "integer", + "examples": [ + 12345 + ] + }, + "url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/github/hello-world/actions/artifacts/5" + ] + }, + "archive_download_url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip" + ] + }, + "expired": { + "description": "Whether or not the artifact has expired.", + "type": "boolean" + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "expires_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "digest": { + "type": [ + "string", + "null" + ], + "description": "The SHA256 digest of the artifact. This field will only be populated on artifacts uploaded with upload-artifact v4 or newer. For older versions, this field will be null.", + "examples": [ + "sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c" + ] + }, + "workflow_run": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "examples": [ + 10 + ] + }, + "repository_id": { + "type": "integer", + "examples": [ + 42 + ] + }, + "head_repository_id": { + "type": "integer", + "examples": [ + 42 + ] + }, + "head_branch": { + "type": "string", + "examples": [ + "main" + ] + }, + "head_sha": { + "type": "string", + "examples": [ + "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" + ] + } + } + } + }, + "required": [ + "id", + "node_id", + "name", + "size_in_bytes", + "url", + "archive_download_url", + "expired", + "created_at", + "expires_at", + "updated_at" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "artifacts": [ + { + "id": 11, + "node_id": "MDg6QXJ0aWZhY3QxMQ==", + "name": "Rails", + "size_in_bytes": 556, + "url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11", + "archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip", + "expired": false, + "created_at": "2020-01-10T14:59:22Z", + "expires_at": "2020-03-21T14:59:22Z", + "updated_at": "2020-02-21T14:59:22Z", + "digest": "sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c", + "workflow_run": { + "id": 2332938, + "repository_id": 1296269, + "head_repository_id": 1296269, + "head_branch": "main", + "head_sha": "328faa0536e6fef19753d9d91dc96a9931694ce3" + } + }, + { + "id": 13, + "node_id": "MDg6QXJ0aWZhY3QxMw==", + "name": "Test output", + "size_in_bytes": 453, + "url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13", + "archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13/zip", + "expired": false, + "created_at": "2020-01-10T14:59:22Z", + "expires_at": "2020-03-21T14:59:22Z", + "updated_at": "2020-02-21T14:59:22Z", + "digest": "sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c", + "workflow_run": { + "id": 2332942, + "repository_id": 1296269, + "head_repository_id": 1296269, + "head_branch": "main", + "head_sha": "178f4f6090b3fccad4a65b3e83d076a622d59652" + } + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "artifacts" + } + } + }, + "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}": { + "get": { + "summary": "Get an artifact", + "description": "Gets a specific artifact for a workflow run.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-artifact", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/artifacts#get-an-artifact" + }, + "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": "artifact_id", + "description": "The unique identifier of the artifact.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Artifact", + "description": "An artifact", + "type": "object", + "properties": { + "id": { + "type": "integer", + "examples": [ + 5 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOkNoZWNrU3VpdGU1" + ] + }, + "name": { + "description": "The name of the artifact.", + "type": "string", + "examples": [ + "AdventureWorks.Framework" + ] + }, + "size_in_bytes": { + "description": "The size in bytes of the artifact.", + "type": "integer", + "examples": [ + 12345 + ] + }, + "url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/github/hello-world/actions/artifacts/5" + ] + }, + "archive_download_url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip" + ] + }, + "expired": { + "description": "Whether or not the artifact has expired.", + "type": "boolean" + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "expires_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "digest": { + "type": [ + "string", + "null" + ], + "description": "The SHA256 digest of the artifact. This field will only be populated on artifacts uploaded with upload-artifact v4 or newer. For older versions, this field will be null.", + "examples": [ + "sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c" + ] + }, + "workflow_run": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "examples": [ + 10 + ] + }, + "repository_id": { + "type": "integer", + "examples": [ + 42 + ] + }, + "head_repository_id": { + "type": "integer", + "examples": [ + 42 + ] + }, + "head_branch": { + "type": "string", + "examples": [ + "main" + ] + }, + "head_sha": { + "type": "string", + "examples": [ + "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" + ] + } + } + } + }, + "required": [ + "id", + "node_id", + "name", + "size_in_bytes", + "url", + "archive_download_url", + "expired", + "created_at", + "expires_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 11, + "node_id": "MDg6QXJ0aWZhY3QxMQ==", + "name": "Rails", + "size_in_bytes": 556, + "url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11", + "archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip", + "expired": false, + "created_at": "2020-01-10T14:59:22Z", + "expires_at": "2020-01-21T14:59:22Z", + "updated_at": "2020-01-21T14:59:22Z", + "digest": "sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c", + "workflow_run": { + "id": 2332938, + "repository_id": 1296269, + "head_repository_id": 1296269, + "head_branch": "main", + "head_sha": "328faa0536e6fef19753d9d91dc96a9931694ce3" + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "artifacts" + } + }, + "delete": { + "summary": "Delete an artifact", + "description": "Deletes an artifact for a workflow run.\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-artifact", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/artifacts#delete-an-artifact" + }, + "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": "artifact_id", + "description": "The unique identifier of the artifact.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "artifacts" + } + } + }, + "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}": { + "get": { + "summary": "Download an artifact", + "description": "Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in\nthe response header to find the URL for the download. The `:archive_format` must be `zip`.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/download-artifact", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/artifacts#download-an-artifact" + }, + "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": "artifact_id", + "description": "The unique identifier of the artifact.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "archive_format", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "302": { + "description": "Response", + "headers": { + "Location": { + "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": { + "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": "actions", + "subcategory": "artifacts" + } + } + }, + "/repos/{owner}/{repo}/actions/cache/usage": { + "get": { + "summary": "Get GitHub Actions cache usage for a repository", + "description": "Gets GitHub Actions cache usage for a repository.\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\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-usage", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-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": { + "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", + "examples": [ + "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", + "examples": [ + 2322142 + ] + }, + "active_caches_count": { + "description": "The number of active caches in the repository.", + "type": "integer", + "examples": [ + 3 + ] + } + }, + "required": [ + "full_name", + "active_caches_size_in_bytes", + "active_caches_count" + ] + }, + "examples": { + "default": { + "value": { + "full_name": "octo-org/Hello-World", + "active_caches_size_in_bytes": 2322142, + "active_caches_count": 3 + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, + "/repos/{owner}/{repo}/actions/caches": { + "get": { + "summary": "List GitHub Actions caches for a repository", + "description": "Lists the GitHub Actions caches for a repository.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-list", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#list-github-actions-caches-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 + } + }, + { + "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 a pull request use `refs/pull//merge`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "key", + "description": "An explicit key or prefix for identifying the cache", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "sort", + "description": "The property to sort the results by. `created_at` means when the cache was created. `last_accessed_at` means when the cache was last accessed. `size_in_bytes` is the size of the cache in bytes.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created_at", + "last_accessed_at", + "size_in_bytes" + ], + "default": "last_accessed_at" + } + }, + { + "name": "direction", + "description": "The direction to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Repository actions caches", + "description": "Repository actions caches", + "type": "object", + "properties": { + "total_count": { + "description": "Total number of caches", + "type": "integer", + "examples": [ + 2 + ] + }, + "actions_caches": { + "description": "Array of caches", + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "examples": [ + 2 + ] + }, + "ref": { + "type": "string", + "examples": [ + "refs/heads/main" + ] + }, + "key": { + "type": "string", + "examples": [ + "Linux-node-958aff96db2d75d67787d1e634ae70b659de937b" + ] + }, + "version": { + "type": "string", + "examples": [ + "73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0" + ] + }, + "last_accessed_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2019-01-24T22:45:36.000Z" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2019-01-24T22:45:36.000Z" + ] + }, + "size_in_bytes": { + "type": "integer", + "examples": [ + 1024 + ] + } + } + } + } + }, + "required": [ + "total_count", + "actions_caches" + ] + }, + "examples": { + "default": { + "value": { + "total_count": 1, + "actions_caches": [ + { + "id": 505, + "ref": "refs/heads/main", + "key": "Linux-node-958aff96db2d75d67787d1e634ae70b659de937b", + "version": "73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0", + "last_accessed_at": "2019-01-24T22:45:36.000Z", + "created_at": "2019-01-24T22:45:36.000Z", + "size_in_bytes": 1024 + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "cache" + } + }, + "delete": { + "summary": "Delete GitHub Actions caches for a repository (using a cache key)", + "description": "Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-actions-cache-by-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key" + }, + "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": "key", + "description": "A key for identifying the cache.", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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 a pull request use `refs/pull//merge`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Repository actions caches", + "description": "Repository actions caches", + "type": "object", + "properties": { + "total_count": { + "description": "Total number of caches", + "type": "integer", + "examples": [ + 2 + ] + }, + "actions_caches": { + "description": "Array of caches", + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "examples": [ + 2 + ] + }, + "ref": { + "type": "string", + "examples": [ + "refs/heads/main" + ] + }, + "key": { + "type": "string", + "examples": [ + "Linux-node-958aff96db2d75d67787d1e634ae70b659de937b" + ] + }, + "version": { + "type": "string", + "examples": [ + "73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0" + ] + }, + "last_accessed_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2019-01-24T22:45:36.000Z" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2019-01-24T22:45:36.000Z" + ] + }, + "size_in_bytes": { + "type": "integer", + "examples": [ + 1024 + ] + } + } + } + } + }, + "required": [ + "total_count", + "actions_caches" + ] + }, + "examples": { + "default": { + "value": { + "total_count": 1, + "actions_caches": [ + { + "id": 505, + "ref": "refs/heads/main", + "key": "Linux-node-958aff96db2d75d67787d1e634ae70b659de937b", + "version": "73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0", + "last_accessed_at": "2019-01-24T22:45:36.000Z", + "created_at": "2019-01-24T22:45:36.000Z", + "size_in_bytes": 1024 + } + ] + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, + "/repos/{owner}/{repo}/actions/caches/{cache_id}": { + "delete": { + "summary": "Delete a GitHub Actions cache for a repository (using a cache ID)", + "description": "Deletes a GitHub Actions cache for a repository, using a cache ID.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-actions-cache-by-id", + "externalDocs": { + "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": [ + { + "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": "cache_id", + "description": "The unique identifier of the GitHub Actions cache.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, + "/repos/{owner}/{repo}/actions/jobs/{job_id}": { + "get": { + "summary": "Get a job for a workflow run", + "description": "Gets a specific job in a workflow run.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-job-for-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run" + }, + "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": "job_id", + "description": "The unique identifier of the job.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Job", + "description": "Information of a job execution in a workflow run", + "type": "object", + "properties": { + "id": { + "description": "The id of the job.", + "type": "integer", + "examples": [ + 21 + ] + }, + "run_id": { + "description": "The id of the associated workflow run.", + "type": "integer", + "examples": [ + 5 + ] + }, + "run_url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/github/hello-world/actions/runs/5" + ] + }, + "run_attempt": { + "type": "integer", + "description": "Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run.", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDg6Q2hlY2tSdW40" + ] + }, + "head_sha": { + "description": "The SHA of the commit that is being run.", + "type": "string", + "examples": [ + "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" + ] + }, + "url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/github/hello-world/actions/jobs/21" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "examples": [ + "https://github.com/github/hello-world/runs/4" + ] + }, + "status": { + "description": "The phase of the lifecycle that the job is currently in.", + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed", + "waiting", + "requested", + "pending" + ], + "examples": [ + "queued" + ] + }, + "conclusion": { + "description": "The outcome of the job.", + "type": [ + "string", + "null" + ], + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + null + ], + "examples": [ + "success" + ] + }, + "created_at": { + "description": "The time that the job created, in ISO 8601 format.", + "format": "date-time", + "type": "string", + "examples": [ + "2019-08-08T08:00:00-07:00" + ] + }, + "started_at": { + "description": "The time that the job started, in ISO 8601 format.", + "format": "date-time", + "type": "string", + "examples": [ + "2019-08-08T08:00:00-07:00" + ] + }, + "completed_at": { + "description": "The time that the job finished, in ISO 8601 format.", + "format": "date-time", + "type": [ + "string", + "null" + ], + "examples": [ + "2019-08-08T08:00:00-07:00" + ] + }, + "name": { + "description": "The name of the job.", + "type": "string", + "examples": [ + "test-coverage" + ] + }, + "steps": { + "description": "Steps in this job.", + "type": "array", + "items": { + "type": "object", + "required": [ + "name", + "status", + "conclusion", + "number" + ], + "properties": { + "status": { + "description": "The phase of the lifecycle that the job is currently in.", + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed" + ], + "examples": [ + "queued" + ] + }, + "conclusion": { + "description": "The outcome of the job.", + "type": [ + "string", + "null" + ], + "examples": [ + "success" + ] + }, + "name": { + "description": "The name of the job.", + "type": "string", + "examples": [ + "test-coverage" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "started_at": { + "description": "The time that the step started, in ISO 8601 format.", + "format": "date-time", + "type": [ + "string", + "null" + ], + "examples": [ + "2019-08-08T08:00:00-07:00" + ] + }, + "completed_at": { + "description": "The time that the job finished, in ISO 8601 format.", + "format": "date-time", + "type": [ + "string", + "null" + ], + "examples": [ + "2019-08-08T08:00:00-07:00" + ] + } + } + } + }, + "check_run_url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/github/hello-world/check-runs/4" + ] + }, + "labels": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Labels for the workflow job. Specified by the \"runs_on\" attribute in the action's workflow file.", + "examples": [ + "self-hosted", + "foo", + "bar" + ] + }, + "runner_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", + "examples": [ + 1 + ] + }, + "runner_name": { + "type": [ + "string", + "null" + ], + "description": "The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", + "examples": [ + "my runner" + ] + }, + "runner_group_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", + "examples": [ + 2 + ] + }, + "runner_group_name": { + "type": [ + "string", + "null" + ], + "description": "The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", + "examples": [ + "my runner group" + ] + }, + "workflow_name": { + "type": [ + "string", + "null" + ], + "description": "The name of the workflow.", + "examples": [ + "Build" + ] + }, + "head_branch": { + "type": [ + "string", + "null" + ], + "description": "The name of the current branch.", + "examples": [ + "main" + ] + } + }, + "required": [ + "id", + "node_id", + "run_id", + "run_url", + "head_sha", + "workflow_name", + "head_branch", + "name", + "url", + "html_url", + "status", + "conclusion", + "started_at", + "completed_at", + "check_run_url", + "labels", + "runner_id", + "runner_name", + "runner_group_id", + "runner_group_name", + "created_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 399444496, + "run_id": 29679449, + "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449", + "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==", + "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0", + "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496", + "html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496", + "status": "completed", + "conclusion": "success", + "started_at": "2020-01-20T17:42:40Z", + "completed_at": "2020-01-20T17:44:39Z", + "name": "build", + "steps": [ + { + "name": "Set up job", + "status": "completed", + "conclusion": "success", + "number": 1, + "started_at": "2020-01-20T09:42:40.000-08:00", + "completed_at": "2020-01-20T09:42:41.000-08:00" + }, + { + "name": "Run actions/checkout@v2", + "status": "completed", + "conclusion": "success", + "number": 2, + "started_at": "2020-01-20T09:42:41.000-08:00", + "completed_at": "2020-01-20T09:42:45.000-08:00" + }, + { + "name": "Set up Ruby", + "status": "completed", + "conclusion": "success", + "number": 3, + "started_at": "2020-01-20T09:42:45.000-08:00", + "completed_at": "2020-01-20T09:42:45.000-08:00" + }, + { + "name": "Run actions/cache@v3", + "status": "completed", + "conclusion": "success", + "number": 4, + "started_at": "2020-01-20T09:42:45.000-08:00", + "completed_at": "2020-01-20T09:42:48.000-08:00" + }, + { + "name": "Install Bundler", + "status": "completed", + "conclusion": "success", + "number": 5, + "started_at": "2020-01-20T09:42:48.000-08:00", + "completed_at": "2020-01-20T09:42:52.000-08:00" + }, + { + "name": "Install Gems", + "status": "completed", + "conclusion": "success", + "number": 6, + "started_at": "2020-01-20T09:42:52.000-08:00", + "completed_at": "2020-01-20T09:42:53.000-08:00" + }, + { + "name": "Run Tests", + "status": "completed", + "conclusion": "success", + "number": 7, + "started_at": "2020-01-20T09:42:53.000-08:00", + "completed_at": "2020-01-20T09:42:59.000-08:00" + }, + { + "name": "Deploy to Heroku", + "status": "completed", + "conclusion": "success", + "number": 8, + "started_at": "2020-01-20T09:42:59.000-08:00", + "completed_at": "2020-01-20T09:44:39.000-08:00" + }, + { + "name": "Post actions/cache@v3", + "status": "completed", + "conclusion": "success", + "number": 16, + "started_at": "2020-01-20T09:44:39.000-08:00", + "completed_at": "2020-01-20T09:44:39.000-08:00" + }, + { + "name": "Complete job", + "status": "completed", + "conclusion": "success", + "number": 17, + "started_at": "2020-01-20T09:44:39.000-08:00", + "completed_at": "2020-01-20T09:44:39.000-08:00" + } + ], + "check_run_url": "https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496", + "labels": [ + "self-hosted", + "foo", + "bar" + ], + "runner_id": 1, + "runner_name": "my runner", + "runner_group_id": 2, + "runner_group_name": "my runner group", + "workflow_name": "CI", + "head_branch": "main" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflow-jobs" + } + } + }, + "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs": { + "get": { + "summary": "Download job logs for a workflow run", + "description": "Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look\nfor `Location:` in the response header to find the URL for the download.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/download-job-logs-for-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run" + }, + "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": "job_id", + "description": "The unique identifier of the job.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "302": { + "description": "Response", + "headers": { + "Location": { + "example": "https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/jobs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflow-jobs" + } + } + }, + "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun": { + "post": { + "summary": "Re-run a job from a workflow run", + "description": "Re-run a job and its dependent jobs in a workflow run.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/re-run-job-for-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run" + }, + "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": "job_id", + "description": "The unique identifier of the job.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": [ + "object", + "null" + ], + "properties": { + "enable_debug_logging": { + "type": "boolean", + "default": false, + "description": "Whether to enable debug logging for the re-run." + } + } + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "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": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/oidc/customization/sub": { + "get": { + "summary": "Get the customization template for an OIDC subject claim for a repository", + "description": "Gets the customization template for an OpenID Connect (OIDC) subject claim.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-custom-oidc-sub-claim-for-repo", + "externalDocs": { + "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": [ + { + "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": "Status response", + "content": { + "application/json": { + "schema": { + "title": "Actions OIDC subject customization for a repository", + "description": "Actions OIDC subject customization for a repository", + "type": "object", + "properties": { + "use_default": { + "description": "Whether to use the default template or not. If `true`, the `include_claim_keys` field is ignored.", + "type": "boolean" + }, + "include_claim_keys": { + "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "use_default" + ] + }, + "examples": { + "default": { + "value": { + "use_default": false, + "include_claim_keys": [ + "repo", + "context" + ] + } + } + } + } + } + }, + "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "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": { + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "oidc" + } + }, + "put": { + "summary": "Set the customization template for an OIDC subject claim for a repository", + "description": "Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-custom-oidc-sub-claim-for-repo", + "externalDocs": { + "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": [ + { + "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": { + "title": "Actions OIDC subject customization for a repository", + "description": "Actions OIDC subject customization for a repository", + "type": "object", + "required": [ + "use_default" + ], + "properties": { + "use_default": { + "description": "Whether to use the default template or not. If `true`, the `include_claim_keys` field is ignored.", + "type": "boolean" + }, + "include_claim_keys": { + "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": { + "use_default": false, + "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" + } + } + } + } + } + }, + "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "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", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "oidc" + } + } + }, + "/repos/{owner}/{repo}/actions/organization-secrets": { + "get": { + "summary": "List repository organization secrets", + "description": "Lists all organization secrets shared with a repository without revealing their encrypted\nvalues.\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 `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-repo-organization-secrets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets" + }, + "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": "object", + "required": [ + "total_count", + "secrets" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "secrets": { + "type": "array", + "items": { + "title": "Actions Secret", + "description": "Set secrets for GitHub Actions.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret.", + "type": "string", + "examples": [ + "SECRET_TOKEN" + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "name", + "created_at", + "updated_at" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "secrets": [ + { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + }, + { + "name": "GIST_ID", + "created_at": "2020-01-10T10:59:22Z", + "updated_at": "2020-01-11T11:59:22Z" + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + } + } + }, + "/repos/{owner}/{repo}/actions/organization-variables": { + "get": { + "summary": "List repository organization variables", + "description": "Lists all organization variables shared with a repository.\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 `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-repo-organization-variables", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/variables#list-repository-organization-variables" + }, + "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 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", + "type": "object", + "properties": { + "name": { + "description": "The name of the variable.", + "type": "string", + "examples": [ + "USERNAME" + ] + }, + "value": { + "description": "The value of the variable.", + "type": "string", + "examples": [ + "octocat" + ] + }, + "created_at": { + "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time", + "examples": [ + "2019-01-24T22:45:36.000Z" + ] + }, + "updated_at": { + "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time", + "examples": [ + "2019-01-24T22:45:36.000Z" + ] + } + }, + "required": [ + "name", + "value", + "created_at", + "updated_at" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "variables": [ + { + "name": "USERNAME", + "value": "octocat", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + }, + { + "name": "EMAIL", + "value": "octocat@github.com", + "created_at": "2020-01-10T10:59:22Z", + "updated_at": "2020-01-11T11:59:22Z" + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + } + }, + "/repos/{owner}/{repo}/actions/permissions": { + "get": { + "summary": "Get GitHub Actions permissions for a repository", + "description": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/get-github-actions-permissions-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-github-actions-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": { + "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" + ] + }, + "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" + ] + }, + "examples": { + "default": { + "value": { + "enabled": true, + "allowed_actions": "selected", + "selected_actions_url": "https://api.github.com/repositories/42/actions/permissions/selected-actions" + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set GitHub Actions permissions for a repository", + "description": "Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/set-github-actions-permissions-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-github-actions-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" + } + }, + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "approval_policy": { + "type": "string", + "enum": [ + "first_time_contributors_new_to_github", + "first_time_contributors", + "all_external_contributors" + ], + "description": "The policy that controls when fork PR workflows require approval from a maintainer." + } + }, + "required": [ + "approval_policy" + ] + }, + "examples": { + "default": { + "summary": "Set approval policy to first time contributors", + "value": { + "approval_policy": "first_time_contributors" + } + } + } + } + } + }, + "x-github": { + "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": { + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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", + "description": "Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/get-allowed-actions-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-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": { + "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": { + "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 a repository", + "description": "Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/set-allowed-actions-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-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" + } + }, + "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" + } + } + }, + "/repos/{owner}/{repo}/actions/permissions/workflow": { + "get": { + "summary": "Get default workflow permissions for a repository", + "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository,\nas well as if GitHub Actions can submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-github-actions-default-workflow-permissions-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-default-workflow-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": { + "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 a repository", + "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions\ncan submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-github-actions-default-workflow-permissions-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-default-workflow-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": "Success response" + }, + "409": { + "description": "Conflict response when changing a setting is prevented by the owning organization" + } + }, + "requestBody": { + "required": true, + "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" + } + } + }, + "/repos/{owner}/{repo}/actions/runners": { + "get": { + "summary": "List self-hosted runners for a repository", + "description": "Lists all self-hosted runners configured in a repository.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-self-hosted-runners-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-a-repository" + }, + "parameters": [ + { + "name": "name", + "description": "The name of a self-hosted runner.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "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": "object", + "required": [ + "total_count", + "runners" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "runners": { + "type": "array", + "items": { + "title": "Self hosted runners", + "description": "A self hosted runner", + "type": "object", + "properties": { + "id": { + "description": "The ID of the runner.", + "type": "integer", + "examples": [ + 5 + ] + }, + "runner_group_id": { + "description": "The ID of the runner group.", + "type": "integer", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the runner.", + "type": "string", + "examples": [ + "iMac" + ] + }, + "os": { + "description": "The Operating System of the runner.", + "type": "string", + "examples": [ + "macos" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "examples": [ + "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": { + "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" + } + ] + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + } + } + }, + "/repos/{owner}/{repo}/actions/runners/downloads": { + "get": { + "summary": "List runner applications for a repository", + "description": "Lists binaries for the runner application that you can download and run.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-runner-applications-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-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": "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" + } + }, + "required": [ + "os", + "architecture", + "download_url", + "filename" + ] + } + }, + "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" + } + ] + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + } + } + }, + "/repos/{owner}/{repo}/actions/runners/generate-jitconfig": { + "post": { + "summary": "Create configuration for a just-in-time runner for a repository", + "description": "Generates a configuration that can be passed to the runner application at startup.\n\nThe authenticated user must have admin access to the repository.\n\nOAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/generate-runner-jitconfig-for-repo", + "externalDocs": { + "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": [ + { + "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": [ + "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": { + "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" + } + } + }, + "examples": { + "default": { + "value": { + "name": "New runner", + "runner_group_id": 1, + "labels": [ + "self-hosted", + "X64", + "macOS", + "no-gpu" + ], + "work_folder": "_work" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "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", + "examples": [ + 5 + ] + }, + "runner_group_id": { + "description": "The ID of the runner group.", + "type": "integer", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the runner.", + "type": "string", + "examples": [ + "iMac" + ] + }, + "os": { + "description": "The Operating System of the runner.", + "type": "string", + "examples": [ + "macos" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "examples": [ + "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": { + "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" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/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" + } + } + } + } + } + } + }, + "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": "self-hosted-runners" + } + } + }, + "/repos/{owner}/{repo}/actions/runners/registration-token": { + "post": { + "summary": "Create a registration token for a repository", + "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 repository to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/create-registration-token-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-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": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Authentication Token", + "description": "Authentication Token", + "type": "object", + "properties": { + "token": { + "description": "The token used for authentication", + "type": "string", + "examples": [ + "v1.1f699f1069f60xxx" + ] + }, + "expires_at": { + "description": "The time this token expires", + "type": "string", + "format": "date-time", + "examples": [ + "2016-07-11T22:14:10Z" + ] + }, + "permissions": { + "type": "object", + "examples": [ + { + "issues": "read", + "deployments": "write" + } + ] + }, + "repositories": { + "description": "The repositories this token has access to", + "type": "array", + "items": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + } + }, + "single_file": { + "type": [ + "string", + "null" + ], + "examples": [ + "config.yaml" + ] + }, + "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" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + } + } + }, + "/repos/{owner}/{repo}/actions/runners/remove-token": { + "post": { + "summary": "Create a remove token for a repository", + "description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. 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 repository to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/create-remove-token-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-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": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Authentication Token", + "description": "Authentication Token", + "type": "object", + "properties": { + "token": { + "description": "The token used for authentication", + "type": "string", + "examples": [ + "v1.1f699f1069f60xxx" + ] + }, + "expires_at": { + "description": "The time this token expires", + "type": "string", + "format": "date-time", + "examples": [ + "2016-07-11T22:14:10Z" + ] + }, + "permissions": { + "type": "object", + "examples": [ + { + "issues": "read", + "deployments": "write" + } + ] + }, + "repositories": { + "description": "The repositories this token has access to", + "type": "array", + "items": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + } + }, + "single_file": { + "type": [ + "string", + "null" + ], + "examples": [ + "config.yaml" + ] + }, + "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" + } + } + }, + "/repos/{owner}/{repo}/actions/runners/{runner_id}": { + "get": { + "summary": "Get a self-hosted runner for a repository", + "description": "Gets a specific self-hosted runner configured in a repository.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-self-hosted-runner-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-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": "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", + "examples": [ + 5 + ] + }, + "runner_group_id": { + "description": "The ID of the runner group.", + "type": "integer", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the runner.", + "type": "string", + "examples": [ + "iMac" + ] + }, + "os": { + "description": "The Operating System of the runner.", + "type": "string", + "examples": [ + "macos" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "examples": [ + "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" + }, + { + "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 a repository", + "description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-self-hosted-runner-from-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-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": "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" + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + } + } + }, + "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels": { + "get": { + "summary": "List labels for a self-hosted runner for a repository", + "description": "Lists all labels for a self-hosted runner configured in a repository.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-labels-for-self-hosted-runner-for-repo", + "externalDocs": { + "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": [ + { + "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": "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": { + "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" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + } + }, + "post": { + "summary": "Add custom labels to a self-hosted runner for a repository", + "description": "Adds custom labels to a self-hosted runner configured in a repository.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/add-custom-labels-to-self-hosted-runner-for-repo", + "externalDocs": { + "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": [ + { + "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": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "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": { + "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" + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + } + }, + "put": { + "summary": "Set custom labels for a self-hosted runner for a repository", + "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-custom-labels-for-self-hosted-runner-for-repo", + "externalDocs": { + "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": [ + { + "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": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "labels" + ], + "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": { + "default": { + "value": { + "labels": [ + "gpu", + "accelerated" + ] + } + } + } + } + } + }, + "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" + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + } + }, + "delete": { + "summary": "Remove all custom labels from a self-hosted runner for a repository", + "description": "Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/remove-all-custom-labels-from-self-hosted-runner-for-repo", + "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-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": "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": { + "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" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + } + } + }, + "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}": { + "delete": { + "summary": "Remove a custom label from a self-hosted runner for a repository", + "description": "Remove a custom label from a self-hosted runner configured\nin a repository. 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 repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/remove-custom-label-from-self-hosted-runner-for-repo", + "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-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": "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", + "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" + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + } + } + }, + "/repos/{owner}/{repo}/actions/runs": { + "get": { + "summary": "List workflow runs for a repository", + "description": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.\n\nThis endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.", + "tags": [ + "actions" + ], + "operationId": "actions/list-workflow-runs-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-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": "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.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "branch", + "description": "Returns workflow runs associated with a branch. Use the name of the branch of the `push`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "event", + "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "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 can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "completed", + "action_required", + "cancelled", + "failure", + "neutral", + "skipped", + "stale", + "success", + "timed_out", + "in_progress", + "queued", + "requested", + "waiting", + "pending" + ] + } + }, + { + "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": "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).\"", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "name": "exclude_pull_requests", + "description": "If `true` pull requests are omitted from the response (empty array).", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": false + } + }, + { + "name": "check_suite_id", + "description": "Returns workflow runs with the `check_suite_id` that you specify.", + "in": "query", + "schema": { + "type": "integer" + } + }, + { + "name": "head_sha", + "description": "Only returns workflow runs that are associated with the specified `head_sha`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "workflow_runs" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "workflow_runs": { + "type": "array", + "items": { + "title": "Workflow Run", + "description": "An invocation of a workflow", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the workflow run.", + "examples": [ + 5 + ] + }, + "name": { + "type": [ + "string", + "null" + ], + "description": "The name of the workflow run.", + "examples": [ + "Build" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOkNoZWNrU3VpdGU1" + ] + }, + "check_suite_id": { + "type": "integer", + "description": "The ID of the associated check suite.", + "examples": [ + 42 + ] + }, + "check_suite_node_id": { + "type": "string", + "description": "The node ID of the associated check suite.", + "examples": [ + "MDEwOkNoZWNrU3VpdGU0Mg==" + ] + }, + "head_branch": { + "type": [ + "string", + "null" + ], + "examples": [ + "master" + ] + }, + "head_sha": { + "description": "The SHA of the head commit that points to the version of the workflow being run.", + "type": "string", + "examples": [ + "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" + ] + }, + "path": { + "description": "The full path of the workflow", + "type": "string", + "examples": [ + "octocat/octo-repo/.github/workflows/ci.yml@main" + ] + }, + "run_number": { + "type": "integer", + "description": "The auto incrementing run number for the workflow run.", + "examples": [ + 106 + ] + }, + "run_attempt": { + "type": "integer", + "description": "Attempt number of the run, 1 for first attempt and higher if the workflow was re-run.", + "examples": [ + 1 + ] + }, + "referenced_workflows": { + "type": [ + "array", + "null" + ], + "items": { + "title": "Referenced workflow", + "description": "A workflow referenced/reused by the initial caller workflow", + "type": "object", + "properties": { + "path": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "ref": { + "type": "string" + } + }, + "required": [ + "path", + "sha" + ] + } + }, + "event": { + "type": "string", + "examples": [ + "push" + ] + }, + "status": { + "type": [ + "string", + "null" + ], + "examples": [ + "completed" + ] + }, + "conclusion": { + "type": [ + "string", + "null" + ], + "examples": [ + "neutral" + ] + }, + "workflow_id": { + "type": "integer", + "description": "The ID of the parent workflow.", + "examples": [ + 5 + ] + }, + "url": { + "type": "string", + "description": "The URL to the workflow run.", + "examples": [ + "https://api.github.com/repos/github/hello-world/actions/runs/5" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "https://github.com/github/hello-world/suites/4" + ] + }, + "pull_requests": { + "description": "Pull requests that are open with a `head_sha` or `head_branch` that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run.", + "type": [ + "array", + "null" + ], + "items": { + "title": "Pull Request Minimal", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + } + }, + "required": [ + "id", + "number", + "url", + "head", + "base" + ] + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "actor": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "triggering_actor": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, "run_started_at": { @@ -322214,6 +326901,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": [ @@ -326267,7 +330978,956 @@ } ] }, - "parent": { + "parent": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "source": { "title": "Repository", "description": "A repository on GitHub.", "type": "object", @@ -327216,1703 +332876,7230 @@ "updated_at" ] }, - "source": { - "title": "Repository", - "description": "A repository on GitHub.", + "forks": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "anonymous_access_enabled": { + "description": "Whether anonymous git access is allowed.", + "default": true, + "type": "boolean" + }, + "code_of_conduct": { + "title": "Code Of Conduct Simple", + "description": "Code of Conduct Simple", "type": "object", "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", + "url": { + "type": "string", + "format": "uri", "examples": [ - 42 + "https://api.github.com/repos/github/docs/community/code_of_conduct" ] }, - "node_id": { + "key": { "type": "string", "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "citizen_code_of_conduct" ] }, "name": { - "description": "The name of the repository.", "type": "string", "examples": [ - "Team Environment" + "Citizen Code of Conduct" ] }, - "full_name": { - "type": "string", + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", "examples": [ - "octocat/Hello-World" + "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md" ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" + } + }, + "required": [ + "url", + "key", + "name", + "html_url" + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "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" ] } - ] - }, - "forks": { - "type": "integer" + } }, - "permissions": { + "code_security": { "type": "object", "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] } - }, - "required": [ - "admin", - "pull", - "push" - ] + } }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "enum": [ + "enabled", + "disabled" ] - }, - "received_events_url": { + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" + "enum": [ + "enabled", + "disabled" ] - }, - "type": { + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { "type": "string", - "examples": [ - "User" + "enum": [ + "enabled", + "disabled" ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" + "enum": [ + "enabled", + "disabled" ] - }, - "user_view_type": { + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { "type": "string", - "examples": [ - "public" + "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", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "has_discussions", + "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", + "network_count", + "subscribers_count" + ] + }, + "examples": { + "default": { + "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}", + "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", + "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" + }, + "language": null, + "forks_count": 9, + "forks": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "open_issues": 0, + "is_template": false, + "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": { + "pull": true, + "push": false, + "admin": false + }, + "allow_rebase_merge": true, + "template_repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World-Template", + "full_name": "octocat/Hello-World-Template", + "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-Template", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World-Template", + "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World-Template.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World-Template.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World-Template.git", + "mirror_url": "git:git.example.com/octocat/Hello-World-Template", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World-Template", + "homepage": "https://github.com", + "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, + "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", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "allow_forking": true, + "web_commit_signoff_required": false, + "subscribers_count": 42, + "network_count": 0, + "organization": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "Organization", + "site_admin": false + }, + "parent": { + "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, + "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://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + }, + "source": { + "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, + "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://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + } + } + } + } + } + }, + "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "forks" + } + } + }, + "/repos/{owner}/{repo}/git/blobs": { + "post": { + "summary": "Create a blob", + "description": "", + "tags": [ + "git" + ], + "operationId": "git/create-blob", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/git/blobs#create-a-blob" + }, + "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": { + "content": { + "type": "string", + "description": "The new blob's content." + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" + } + }, + "required": [ + "content" + ] + }, + "examples": { + "default": { + "value": { + "content": "Content of the blob", + "encoding": "utf-8" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Short Blob", + "description": "Short Blob", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "sha": { + "type": "string" + } + }, + "required": [ + "url", + "sha" + ] + }, + "examples": { + "default": { + "value": { + "url": "https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15", + "sha": "3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15" + } + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15", + "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" + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "422": { + "description": "Validation failed", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + }, + { + "description": "Repository rule violation was detected", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "status": { + "type": "string" + }, + "metadata": { + "type": "object", + "properties": { + "secret_scanning": { + "type": "object", + "properties": { + "bypass_placeholders": { + "type": "array", + "items": { + "type": "object", + "properties": { + "placeholder_id": { + "description": "The ID of the push protection bypass placeholder. This value is returned on any push protected routes.", + "type": "string" + }, + "token_type": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + ] + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "git", + "subcategory": "blobs" + } + } + }, + "/repos/{owner}/{repo}/git/blobs/{file_sha}": { + "get": { + "summary": "Get a blob", + "description": "The `content` in the response will always be Base64 encoded.\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 blob data.\n- **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified.\n\n**Note** This endpoint supports blobs up to 100 megabytes in size.", + "tags": [ + "git" + ], + "operationId": "git/get-blob", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/git/blobs#get-a-blob" + }, + "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": "file_sha", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Blob", + "description": "Blob", + "type": "object", + "properties": { + "content": { + "type": "string" + }, + "encoding": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "sha": { + "type": "string" + }, + "size": { + "type": [ + "integer", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "highlighted_content": { + "type": "string" + } + }, + "required": [ + "sha", + "url", + "node_id", + "size", + "content", + "encoding" + ] + }, + "examples": { + "default": { + "value": { + "content": "Q29udGVudCBvZiB0aGUgYmxvYg==", + "encoding": "base64", + "url": "https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15", + "sha": "3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15", + "size": 19, + "node_id": "Q29udGVudCBvZiB0aGUgYmxvYg==" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/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" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "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": "git", + "subcategory": "blobs" + } + } + }, + "/repos/{owner}/{repo}/git/commits": { + "post": { + "summary": "Create a commit", + "description": "Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "tags": [ + "git" + ], + "operationId": "git/create-commit", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/git/commits#create-a-commit" + }, + "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": { + "message": { + "type": "string", + "description": "The commit message" + }, + "tree": { + "type": "string", + "description": "The SHA of the tree object this commit points to" + }, + "parents": { + "type": "array", + "description": "The full SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.", + "items": { + "type": "string" + } + }, + "author": { + "type": "object", + "description": "Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details.", + "properties": { + "name": { + "type": "string", + "description": "The name of the author (or committer) of the commit" + }, + "email": { + "type": "string", + "description": "The email of the author (or committer) of the commit" + }, + "date": { + "type": "string", + "format": "date-time", + "description": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." + } + }, + "required": [ + "name", + "email" + ] + }, + "committer": { + "type": "object", + "description": "Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details.", + "properties": { + "name": { + "type": "string", + "description": "The name of the author (or committer) of the commit" + }, + "email": { + "type": "string", + "description": "The email of the author (or committer) of the commit" + }, + "date": { + "type": "string", + "format": "date-time", + "description": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." + } + } + }, + "signature": { + "type": "string", + "description": "The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits." + } + }, + "required": [ + "message", + "tree" + ] + }, + "examples": { + "default": { + "value": { + "message": "my commit message", + "author": { + "name": "Mona Octocat", + "email": "octocat@github.com", + "date": "2008-07-09T16:13:30+12:00" + }, + "parents": [ + "7d1b31e74ee336d15cbd21741bc88a537ed063a0" + ], + "tree": "827efc6d56897b048c772eb4087f854f46256132", + "signature": "-----BEGIN PGP SIGNATURE-----\n\niQIzBAABAQAdFiEESn/54jMNIrGSE6Tp6cQjvhfv7nAFAlnT71cACgkQ6cQjvhfv\n7nCWwA//XVqBKWO0zF+bZl6pggvky3Oc2j1pNFuRWZ29LXpNuD5WUGXGG209B0hI\nDkmcGk19ZKUTnEUJV2Xd0R7AW01S/YSub7OYcgBkI7qUE13FVHN5ln1KvH2all2n\n2+JCV1HcJLEoTjqIFZSSu/sMdhkLQ9/NsmMAzpf/iIM0nQOyU4YRex9eD1bYj6nA\nOQPIDdAuaTQj1gFPHYLzM4zJnCqGdRlg0sOM/zC5apBNzIwlgREatOYQSCfCKV7k\nnrU34X8b9BzQaUx48Qa+Dmfn5KQ8dl27RNeWAqlkuWyv3pUauH9UeYW+KyuJeMkU\n+NyHgAsWFaCFl23kCHThbLStMZOYEnGagrd0hnm1TPS4GJkV4wfYMwnI4KuSlHKB\njHl3Js9vNzEUQipQJbgCgTiWvRJoK3ENwBTMVkKHaqT4x9U4Jk/XZB6Q8MA09ezJ\n3QgiTjTAGcum9E9QiJqMYdWQPWkaBIRRz5cET6HPB48YNXAAUsfmuYsGrnVLYbG+\nUpC6I97VybYHTy2O9XSGoaLeMI9CsFn38ycAxxbWagk5mhclNTP5mezIq6wKSwmr\nX11FW3n1J23fWZn5HJMBsRnUCgzqzX3871IqLYHqRJ/bpZ4h20RhTyPj5c/z7QXp\neSakNQMfbbMcljkha+ZMuVQX1K9aRlVqbmv3ZMWh+OijLYVU2bc=\n=5Io4\n-----END PGP SIGNATURE-----\n" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Git Commit", + "description": "Low-level Git commit operations within a repository", + "type": "object", + "properties": { + "sha": { + "description": "SHA for the commit", + "type": "string", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "author": { + "description": "Identifying information for the git-user", + "type": "object", + "properties": { + "date": { + "description": "Timestamp of the commit", + "format": "date-time", + "type": "string", + "examples": [ + "2014-08-09T08:02:04+12:00" ] }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" + "email": { + "type": "string", + "description": "Git email address of the user", + "examples": [ + "monalisa.octocat@example.com" + ] }, - "html_url": { + "name": { + "description": "Name of the git user", "type": "string", - "format": "uri", "examples": [ - "https://github.com/octocat/Hello-World" + "Monalisa Octocat" + ] + } + }, + "required": [ + "email", + "name", + "date" + ] + }, + "committer": { + "description": "Identifying information for the git-user", + "type": "object", + "properties": { + "date": { + "description": "Timestamp of the commit", + "format": "date-time", + "type": "string", + "examples": [ + "2014-08-09T08:02:04+12:00" ] }, - "description": { - "type": [ - "string", - "null" - ], + "email": { + "type": "string", + "description": "Git email address of the user", "examples": [ - "This your first repo!" + "monalisa.octocat@example.com" ] }, - "fork": { + "name": { + "description": "Name of the git user", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] + } + }, + "required": [ + "email", + "name", + "date" + ] + }, + "message": { + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] + }, + "tree": { + "type": "object", + "properties": { + "sha": { + "description": "SHA for the commit", + "type": "string", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "sha", + "url" + ] + }, + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sha": { + "description": "SHA for the commit", + "type": "string", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "sha", + "url", + "html_url" + ] + } + }, + "verification": { + "type": "object", + "properties": { + "verified": { "type": "boolean" }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] + "reason": { + "type": "string" }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + "signature": { + "type": [ + "string", + "null" ] }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + "payload": { + "type": [ + "string", + "null" ] }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + "verified_at": { + "type": [ + "string", + "null" ] - }, - "comments_url": { + } + }, + "required": [ + "verified", + "reason", + "signature", + "payload", + "verified_at" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "sha", + "node_id", + "url", + "html_url", + "author", + "committer", + "tree", + "message", + "parents", + "verification" + ] + }, + "examples": { + "default": { + "value": { + "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", + "node_id": "MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==", + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd", + "author": { + "date": "2014-11-07T22:01:45Z", + "name": "Monalisa Octocat", + "email": "octocat@github.com" + }, + "committer": { + "date": "2014-11-07T22:01:45Z", + "name": "Monalisa Octocat", + "email": "octocat@github.com" + }, + "message": "my commit message", + "tree": { + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/827efc6d56897b048c772eb4087f854f46256132", + "sha": "827efc6d56897b048c772eb4087f854f46256132" + }, + "parents": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7d1b31e74ee336d15cbd21741bc88a537ed063a0", + "sha": "7d1b31e74ee336d15cbd21741bc88a537ed063a0", + "html_url": "https://github.com/octocat/Hello-World/commit/7d1b31e74ee336d15cbd21741bc88a537ed063a0" + } + ], + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null, + "verified_at": null + }, + "html_url": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" + } + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd", + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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" + } + } + } + } + } + }, + "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": "git", + "subcategory": "commits" + } + } + }, + "/repos/{owner}/{repo}/git/commits/{commit_sha}": { + "get": { + "summary": "Get a commit object", + "description": "Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).\n\nTo get the contents of a commit, see \"[Get a commit](/rest/commits/commits#get-a-commit).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "tags": [ + "git" + ], + "operationId": "git/get-commit", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/git/commits#get-a-commit-object" + }, + "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": "commit_sha", + "description": "The SHA of the commit.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Git Commit", + "description": "Low-level Git commit operations within a repository", + "type": "object", + "properties": { + "sha": { + "description": "SHA for the commit", + "type": "string", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "author": { + "description": "Identifying information for the git-user", + "type": "object", + "properties": { + "date": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + "2014-08-09T08:02:04+12:00" ] }, - "commits_url": { + "email": { "type": "string", + "description": "Git email address of the user", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "monalisa.octocat@example.com" ] }, - "compare_url": { + "name": { + "description": "Name of the git user", "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "Monalisa Octocat" ] - }, - "contents_url": { + } + }, + "required": [ + "email", + "name", + "date" + ] + }, + "committer": { + "description": "Identifying information for the git-user", + "type": "object", + "properties": { + "date": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "2014-08-09T08:02:04+12:00" ] }, - "contributors_url": { + "email": { "type": "string", - "format": "uri", + "description": "Git email address of the user", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" + "monalisa.octocat@example.com" ] }, - "deployments_url": { + "name": { + "description": "Name of the git user", "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" + "Monalisa Octocat" ] - }, - "downloads_url": { + } + }, + "required": [ + "email", + "name", + "date" + ] + }, + "message": { + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] + }, + "tree": { + "type": "object", + "properties": { + "sha": { + "description": "SHA for the commit", "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" + "7638417db6d59f3c431d3e1f261cc637155684cd" ] }, - "events_url": { + "url": { "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] + "format": "uri" + } + }, + "required": [ + "sha", + "url" + ] + }, + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sha": { + "description": "SHA for the commit", + "type": "string", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + } }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] + "required": [ + "sha", + "url", + "html_url" + ] + } + }, + "verification": { + "type": "object", + "properties": { + "verified": { + "type": "boolean" }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] + "reason": { + "type": "string" }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + "signature": { + "type": [ + "string", + "null" ] }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + "payload": { + "type": [ + "string", + "null" ] }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" + "verified_at": { + "type": [ + "string", + "null" ] + } + }, + "required": [ + "verified", + "reason", + "signature", + "payload", + "verified_at" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "sha", + "node_id", + "url", + "html_url", + "author", + "committer", + "tree", + "message", + "parents", + "verification" + ] + }, + "examples": { + "default": { + "value": { + "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", + "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd", + "html_url": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd", + "author": { + "date": "2014-11-07T22:01:45Z", + "name": "Monalisa Octocat", + "email": "octocat@github.com" + }, + "committer": { + "date": "2014-11-07T22:01:45Z", + "name": "Monalisa Octocat", + "email": "octocat@github.com" + }, + "message": "added readme, because im a good github citizen", + "tree": { + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb", + "sha": "691272480426f78a0138979dd3ce63b77f706feb" + }, + "parents": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5", + "sha": "1acc419d4d6a9ce985db7be48c6349a0475975b5", + "html_url": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" + } + ], + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null, + "verified_at": 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" + } + } + } + } + } + }, + "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": "git", + "subcategory": "commits" + } + } + }, + "/repos/{owner}/{repo}/git/matching-refs/{ref}": { + "get": { + "summary": "List matching references", + "description": "Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array.\n\nWhen you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`.\n\n> [!NOTE]\n> You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nIf you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`.", + "tags": [ + "git" + ], + "operationId": "git/list-matching-refs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/git/refs#list-matching-references" + }, + "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": "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.", + "in": "path", + "required": true, + "example": "heads/feature-a", + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Git Reference", + "description": "Git references within a repository", + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "object": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "sha": { + "description": "SHA for the reference", + "type": "string", + "minLength": 40, + "maxLength": 40, + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "url": { + "type": "string", + "format": "uri" + } }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] + "required": [ + "type", + "sha", + "url" + ] + } + }, + "required": [ + "ref", + "node_id", + "url", + "object" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "ref": "refs/heads/feature-a", + "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlLWE=", + "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-a", + "object": { + "type": "commit", + "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd" + } + }, + { + "ref": "refs/heads/feature-b", + "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlLWI=", + "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-b", + "object": { + "type": "commit", + "sha": "612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac", + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac" + } + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "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": "git", + "subcategory": "refs" + } + } + }, + "/repos/{owner}/{repo}/git/ref/{ref}": { + "get": { + "summary": "Get a reference", + "description": "Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.\n\n> [!NOTE]\n> You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".", + "tags": [ + "git" + ], + "operationId": "git/get-ref", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/git/refs#get-a-reference" + }, + "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": "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.", + "in": "path", + "required": true, + "example": "heads/feature-a", + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Git Reference", + "description": "Git references within a repository", + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "object": { + "type": "object", + "properties": { + "type": { + "type": "string" }, - "issue_events_url": { + "sha": { + "description": "SHA for the reference", "type": "string", + "minLength": 40, + "maxLength": 40, "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + "7638417db6d59f3c431d3e1f261cc637155684cd" ] }, - "issues_url": { + "url": { "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] + "format": "uri" + } + }, + "required": [ + "type", + "sha", + "url" + ] + } + }, + "required": [ + "ref", + "node_id", + "url", + "object" + ] + }, + "examples": { + "default": { + "value": { + "ref": "refs/heads/featureA", + "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==", + "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA", + "object": { + "type": "commit", + "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd" + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/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" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "git", + "subcategory": "refs" + } + } + }, + "/repos/{owner}/{repo}/git/refs": { + "post": { + "summary": "Create a reference", + "description": "Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.", + "tags": [ + "git" + ], + "operationId": "git/create-ref", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/git/refs#create-a-reference" + }, + "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": { + "ref": { + "type": "string", + "description": "The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected." + }, + "sha": { + "type": "string", + "description": "The SHA1 value for this reference." + } + }, + "required": [ + "ref", + "sha" + ] + }, + "examples": { + "default": { + "value": { + "ref": "refs/heads/featureA", + "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Git Reference", + "description": "Git references within a repository", + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "object": { + "type": "object", + "properties": { + "type": { + "type": "string" }, - "keys_url": { + "sha": { + "description": "SHA for the reference", "type": "string", + "minLength": 40, + "maxLength": 40, "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + "7638417db6d59f3c431d3e1f261cc637155684cd" ] }, - "labels_url": { + "url": { "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] + "format": "uri" + } + }, + "required": [ + "type", + "sha", + "url" + ] + } + }, + "required": [ + "ref", + "node_id", + "url", + "object" + ] + }, + "examples": { + "default": { + "value": { + "ref": "refs/heads/featureA", + "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==", + "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA", + "object": { + "type": "commit", + "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd" + } + } + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA", + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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": "git", + "subcategory": "refs" + } + } + }, + "/repos/{owner}/{repo}/git/refs/{ref}": { + "patch": { + "summary": "Update a reference", + "description": "Updates the provided reference to point to a new SHA. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.", + "tags": [ + "git" + ], + "operationId": "git/update-ref", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/git/refs#update-a-reference" + }, + "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": "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.", + "in": "path", + "required": true, + "example": "heads/feature-a", + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "description": "The SHA1 value to set this reference to" + }, + "force": { + "type": "boolean", + "description": "Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work.", + "default": false + } + }, + "required": [ + "sha" + ] + }, + "examples": { + "default": { + "value": { + "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", + "force": true + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Git Reference", + "description": "Git references within a repository", + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "object": { + "type": "object", + "properties": { + "type": { + "type": "string" }, - "languages_url": { + "sha": { + "description": "SHA for the reference", "type": "string", - "format": "uri", + "minLength": 40, + "maxLength": 40, "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" + "7638417db6d59f3c431d3e1f261cc637155684cd" ] }, - "merges_url": { + "url": { "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] + "format": "uri" + } + }, + "required": [ + "type", + "sha", + "url" + ] + } + }, + "required": [ + "ref", + "node_id", + "url", + "object" + ] + }, + "examples": { + "default": { + "value": { + "ref": "refs/heads/featureA", + "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==", + "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA", + "object": { + "type": "commit", + "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd" + } + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "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": "git", + "subcategory": "refs" + } + }, + "delete": { + "summary": "Delete a reference", + "description": "Deletes the provided reference.", + "tags": [ + "git" + ], + "operationId": "git/delete-ref", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/git/refs#delete-a-reference" + }, + "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": "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.", + "in": "path", + "required": true, + "example": "heads/feature-a", + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "responses": { + "204": { + "description": "Response" + }, + "422": { + "description": "Validation failed, an attempt was made to delete the default branch, or the endpoint has been spammed." + }, + "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": "git", + "subcategory": "refs" + } + } + }, + "/repos/{owner}/{repo}/git/tags": { + "post": { + "summary": "Create a tag object", + "description": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "tags": [ + "git" + ], + "operationId": "git/create-tag", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/git/tags#create-a-tag-object" + }, + "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": { + "tag": { + "type": "string", + "description": "The tag's name. This is typically a version (e.g., \"v0.0.1\")." + }, + "message": { + "type": "string", + "description": "The tag message." + }, + "object": { + "type": "string", + "description": "The SHA of the git object this is tagging." + }, + "type": { + "type": "string", + "description": "The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`.", + "enum": [ + "commit", + "tree", + "blob" + ] + }, + "tagger": { + "type": "object", + "description": "An object with information about the individual creating the tag.", + "properties": { + "name": { + "type": "string", + "description": "The name of the author of the tag" + }, + "email": { + "type": "string", + "description": "The email of the author of the tag" + }, + "date": { + "type": "string", + "format": "date-time", + "description": "When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." + } + }, + "required": [ + "name", + "email" + ] + } + }, + "required": [ + "tag", + "message", + "object", + "type" + ] + }, + "examples": { + "default": { + "value": { + "tag": "v0.0.1", + "message": "initial version", + "object": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c", + "type": "commit", + "tagger": { + "name": "Monalisa Octocat", + "email": "octocat@github.com", + "date": "2011-06-17T14:53:35-07:00" + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Git Tag", + "description": "Metadata for a Git tag", + "type": "object", + "properties": { + "node_id": { + "type": "string", + "examples": [ + "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==" + ] + }, + "tag": { + "description": "Name of the tag", + "type": "string", + "examples": [ + "v0.0.1" + ] + }, + "sha": { + "type": "string", + "examples": [ + "940bd336248efae0f9ee5bc7b2d5c985887b16ac" + ] + }, + "url": { + "description": "URL for the tag", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac" + ] + }, + "message": { + "description": "Message describing the purpose of the tag", + "type": "string", + "examples": [ + "Initial public release" + ] + }, + "tagger": { + "type": "object", + "properties": { + "date": { + "type": "string" }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] + "email": { + "type": "string" }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] + "name": { + "type": "string" + } + }, + "required": [ + "date", + "email", + "name" + ] + }, + "object": { + "type": "object", + "properties": { + "sha": { + "type": "string" }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] + "type": { + "type": "string" }, - "releases_url": { + "url": { "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] + "format": "uri" + } + }, + "required": [ + "sha", + "type", + "url" + ] + }, + "verification": { + "title": "Verification", + "type": "object", + "properties": { + "verified": { + "type": "boolean" }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] + "reason": { + "type": "string" }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" + "payload": { + "type": [ + "string", + "null" ] }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + "signature": { + "type": [ + "string", + "null" ] }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" + "verified_at": { + "type": [ + "string", + "null" ] + } + }, + "required": [ + "verified", + "reason", + "payload", + "signature", + "verified_at" + ] + } + }, + "required": [ + "sha", + "url", + "node_id", + "tagger", + "object", + "tag", + "message" + ] + }, + "examples": { + "default": { + "value": { + "node_id": "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==", + "tag": "v0.0.1", + "sha": "940bd336248efae0f9ee5bc7b2d5c985887b16ac", + "url": "https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac", + "message": "initial version", + "tagger": { + "name": "Monalisa Octocat", + "email": "octocat@github.com", + "date": "2014-11-07T22:01:45Z" + }, + "object": { + "type": "commit", + "sha": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c", + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c" + }, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null, + "verified_at": null + } + } + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac", + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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": "git", + "subcategory": "tags" + } + } + }, + "/repos/{owner}/{repo}/git/tags/{tag_sha}": { + "get": { + "summary": "Get a tag", + "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "tags": [ + "git" + ], + "operationId": "git/get-tag", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/git/tags#get-a-tag" + }, + "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": "tag_sha", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Git Tag", + "description": "Metadata for a Git tag", + "type": "object", + "properties": { + "node_id": { + "type": "string", + "examples": [ + "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==" + ] + }, + "tag": { + "description": "Name of the tag", + "type": "string", + "examples": [ + "v0.0.1" + ] + }, + "sha": { + "type": "string", + "examples": [ + "940bd336248efae0f9ee5bc7b2d5c985887b16ac" + ] + }, + "url": { + "description": "URL for the tag", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac" + ] + }, + "message": { + "description": "Message describing the purpose of the tag", + "type": "string", + "examples": [ + "Initial public release" + ] + }, + "tagger": { + "type": "object", + "properties": { + "date": { + "type": "string" }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] + "email": { + "type": "string" }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] + "name": { + "type": "string" + } + }, + "required": [ + "date", + "email", + "name" + ] + }, + "object": { + "type": "object", + "properties": { + "sha": { + "type": "string" }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] + "type": { + "type": "string" }, - "trees_url": { + "url": { "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] + "format": "uri" + } + }, + "required": [ + "sha", + "type", + "url" + ] + }, + "verification": { + "title": "Verification", + "type": "object", + "properties": { + "verified": { + "type": "boolean" }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] + "reason": { + "type": "string" }, - "mirror_url": { + "payload": { "type": [ "string", "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { + "signature": { "type": [ "string", "null" - ], - "format": "uri", - "examples": [ - "https://github.com" ] }, - "language": { + "verified_at": { "type": [ "string", "null" ] + } + }, + "required": [ + "verified", + "reason", + "payload", + "signature", + "verified_at" + ] + } + }, + "required": [ + "sha", + "url", + "node_id", + "tagger", + "object", + "tag", + "message" + ] + }, + "examples": { + "default": { + "value": { + "node_id": "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==", + "tag": "v0.0.1", + "sha": "940bd336248efae0f9ee5bc7b2d5c985887b16ac", + "url": "https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac", + "message": "initial version", + "tagger": { + "name": "Monalisa Octocat", + "email": "octocat@github.com", + "date": "2014-11-07T22:01:45Z" + }, + "object": { + "type": "commit", + "sha": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c", + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c" + }, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null, + "verified_at": 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" + } + } + } + } + } + }, + "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": "git", + "subcategory": "tags" + } + } + }, + "/repos/{owner}/{repo}/git/trees": { + "post": { + "summary": "Create a tree", + "description": "The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.\n\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"[Create a commit](https://docs.github.com/rest/git/commits#create-a-commit)\" and \"[Update a reference](https://docs.github.com/rest/git/refs#update-a-reference).\"\n\nReturns an error if you try to delete a file that does not exist.", + "tags": [ + "git" + ], + "operationId": "git/create-tree", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/git/trees#create-a-tree" + }, + "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": { + "tree": { + "type": "array", + "description": "Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure.", + "items": { + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file referenced in the tree." }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 + "mode": { + "type": "string", + "description": "The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink.", + "enum": [ + "100644", + "100755", + "040000", + "160000", + "120000" ] }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 + "type": { + "type": "string", + "description": "Either `blob`, `tree`, or `commit`.", + "enum": [ + "blob", + "tree", + "commit" ] }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] + "sha": { + "type": [ + "string", + "null" + ], + "description": "The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error." }, - "default_branch": { - "description": "The default branch of the repository.", + "content": { "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] + "description": "The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error." + } + } + } + }, + "base_tree": { + "type": "string", + "description": "The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit." + } + }, + "required": [ + "tree" + ] + }, + "examples": { + "default": { + "value": { + "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312", + "tree": [ + { + "path": "file.rb", + "mode": "100644", + "type": "blob", + "sha": "44b4fc6d56897b048c772eb4087f854f46256132" + } + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Git Tree", + "description": "The hierarchy between files in a Git repository.", + "type": "object", + "properties": { + "sha": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "truncated": { + "type": "boolean" + }, + "tree": { + "description": "Objects specifying a tree structure", + "type": "array", + "items": { + "type": "object", + "required": [ + "path", + "mode", + "type", + "sha" + ], + "properties": { + "path": { + "type": "string", + "examples": [ + "test/file.rb" + ] + }, + "mode": { + "type": "string", + "examples": [ + "040000" + ] + }, + "type": { + "type": "string", + "examples": [ + "tree" + ] + }, + "sha": { + "type": "string", + "examples": [ + "23f6827669e43831def8a7ad935069c8bd418261" + ] + }, + "size": { + "type": "integer", + "examples": [ + 12 + ] + }, + "url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/owner-482f3203ecf01f67e9deb18e/BBB_Private_Repo/git/blobs/23f6827669e43831def8a7ad935069c8bd418261" + ] + } + } + }, + "examples": [ + { + "path": "file.rb", + "mode": "100644", + "type": "blob", + "size": 30, + "sha": "44b4fc6d56897b048c772eb4087f854f46256132", + "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132" + } + ] + } + }, + "required": [ + "sha", + "tree", + "truncated" + ] + }, + "examples": { + "default": { + "value": { + "sha": "cd8274d15fa3ae2ab983129fb037999f264ba9a7", + "url": "https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7", + "tree": [ + { + "path": "file.rb", + "mode": "100644", + "type": "blob", + "size": 132, + "sha": "7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b", + "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b" + } + ], + "truncated": true + } + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7", + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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" + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "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": "git", + "subcategory": "trees" + } + } + }, + "/repos/{owner}/{repo}/git/trees/{tree_sha}": { + "get": { + "summary": "Get a tree", + "description": "Returns a single tree using the SHA1 value or ref name for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.\n\n> [!NOTE]\n> The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.", + "tags": [ + "git" + ], + "operationId": "git/get-tree", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/git/trees#get-a-tree" + }, + "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": "tree_sha", + "description": "The SHA1 value or ref (branch or tag) name of the tree.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + { + "name": "recursive", + "description": "Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` to any of the following will enable returning objects or subtrees: `0`, `1`, `\"true\"`, and `\"false\"`. Omit this parameter to prevent recursively returning objects or subtrees.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Git Tree", + "description": "The hierarchy between files in a Git repository.", + "type": "object", + "properties": { + "sha": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "truncated": { + "type": "boolean" + }, + "tree": { + "description": "Objects specifying a tree structure", + "type": "array", + "items": { + "type": "object", + "required": [ + "path", + "mode", + "type", + "sha" + ], + "properties": { + "path": { + "type": "string", + "examples": [ + "test/file.rb" + ] + }, + "mode": { + "type": "string", + "examples": [ + "040000" + ] + }, + "type": { + "type": "string", + "examples": [ + "tree" + ] + }, + "sha": { + "type": "string", + "examples": [ + "23f6827669e43831def8a7ad935069c8bd418261" + ] + }, + "size": { + "type": "integer", + "examples": [ + 12 + ] + }, + "url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/owner-482f3203ecf01f67e9deb18e/BBB_Private_Repo/git/blobs/23f6827669e43831def8a7ad935069c8bd418261" + ] + } + } + }, + "examples": [ + { + "path": "file.rb", + "mode": "100644", + "type": "blob", + "size": 30, + "sha": "44b4fc6d56897b048c772eb4087f854f46256132", + "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132" + } + ] + } + }, + "required": [ + "sha", + "tree", + "truncated" + ] + }, + "examples": { + "default-response": { + "summary": "Default response", + "value": { + "sha": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312", + "url": "https://api.github.com/repos/octocat/Hello-World/trees/9fb037999f264ba9a7fc6274d15fa3ae2ab98312", + "tree": [ + { + "path": "file.rb", + "mode": "100644", + "type": "blob", + "size": 30, + "sha": "44b4fc6d56897b048c772eb4087f854f46256132", + "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132" }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] + { + "path": "subdir", + "mode": "040000", + "type": "tree", + "sha": "f484d249c660418515fb01c2b9662073663c242e", + "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/f484d249c660418515fb01c2b9662073663c242e" }, - "topics": { - "type": "array", - "items": { + { + "path": "exec_file", + "mode": "100755", + "type": "blob", + "size": 75, + "sha": "45b983be36b73c0788dc9cbcb76cbb80fc7bb057", + "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/45b983be36b73c0788dc9cbcb76cbb80fc7bb057" + } + ], + "truncated": false + } + }, + "response-recursively-retrieving-a-tree": { + "summary": "Response recursively retrieving a tree", + "value": { + "sha": "fc6274d15fa3ae2ab983129fb037999f264ba9a7", + "url": "https://api.github.com/repos/octocat/Hello-World/trees/fc6274d15fa3ae2ab983129fb037999f264ba9a7", + "tree": [ + { + "path": "subdir/file.txt", + "mode": "100644", + "type": "blob", + "size": 132, + "sha": "7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b", + "url": "https://api.github.com/repos/octocat/Hello-World/git/7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b" + } + ], + "truncated": false + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/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" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "git", + "subcategory": "trees" + } + } + }, + "/repos/{owner}/{repo}/hooks": { + "get": { + "summary": "List repository webhooks", + "description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.", + "tags": [ + "repos" + ], + "operationId": "repos/list-webhooks", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/webhooks#list-repository-webhooks" + }, + "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": "Webhook", + "description": "Webhooks for repositories.", + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "id": { + "description": "Unique identifier of the webhook.", + "type": "integer", + "examples": [ + 42 + ] + }, + "name": { + "description": "The name of a valid service, use 'web' for a webhook.", + "type": "string", + "examples": [ + "web" + ] + }, + "active": { + "description": "Determines whether the hook is actually triggered on pushes.", + "type": "boolean", + "examples": [ + true + ] + }, + "events": { + "description": "Determines what events the hook is triggered for. Default: ['push'].", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "push", + "pull_request" + ] + }, + "config": { + "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.", + "format": "uri", + "examples": [ + "https://example.com/webhook" + ] + }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"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).", + "examples": [ + "\"********\"" + ] + }, + "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.**", + "examples": [ + "\"0\"" + ] + }, + { + "type": "number" + } + ] + } + } + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-09-06T20:39:23Z" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-09-06T17:26:27Z" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks/1" + ] + }, + "test_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks/1/test" + ] + }, + "ping_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks/1/pings" + ] + }, + "deliveries_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries" + ] + }, + "last_response": { + "title": "Hook Response", + "type": "object", + "properties": { + "code": { + "type": [ + "integer", + "null" + ] + }, + "status": { + "type": [ + "string", + "null" + ] + }, + "message": { + "type": [ + "string", + "null" + ] } }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] + "required": [ + "code", + "status", + "message" + ] + } + }, + "required": [ + "id", + "url", + "type", + "name", + "active", + "events", + "config", + "ping_url", + "created_at", + "updated_at", + "last_response", + "test_url" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "type": "Repository", + "id": 12345678, + "name": "web", + "active": true, + "events": [ + "push", + "pull_request" + ], + "config": { + "content_type": "json", + "insecure_ssl": "0", + "url": "https://example.com/webhook" }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", + "updated_at": "2019-06-03T00:57:16Z", + "created_at": "2019-06-03T00:57:16Z", + "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", + "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test", + "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings", + "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", + "last_response": { + "code": null, + "status": "unused", + "message": null + } + } + ] + } + } + } + }, + "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": "repos", + "subcategory": "webhooks" + } + }, + "post": { + "summary": "Create a repository webhook", + "description": "Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can\nshare the same `config` as long as those webhooks do not have any `events` that overlap.", + "tags": [ + "repos" + ], + "operationId": "repos/create-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook" + }, + "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": false, + "content": { + "application/json": { + "schema": { + "type": [ + "object", + "null" + ], + "properties": { + "name": { + "type": "string", + "description": "Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `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.", + "format": "uri", + "examples": [ + "https://example.com/webhook" + ] + }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"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).", + "examples": [ + "\"********\"" + ] + }, + "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.**", + "examples": [ + "\"0\"" + ] + }, + { + "type": "number" + } + ] + } + } + }, + "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 + } + }, + "additionalProperties": false + }, + "examples": { + "default": { + "value": { + "name": "web", + "active": true, + "events": [ + "push", + "pull_request" + ], + "config": { + "url": "https://example.com/webhook", + "content_type": "json", + "insecure_ssl": "0" + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Webhook", + "description": "Webhooks for repositories.", + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "id": { + "description": "Unique identifier of the webhook.", + "type": "integer", + "examples": [ + 42 + ] + }, + "name": { + "description": "The name of a valid service, use 'web' for a webhook.", + "type": "string", + "examples": [ + "web" + ] + }, + "active": { + "description": "Determines whether the hook is actually triggered on pushes.", + "type": "boolean", + "examples": [ + true + ] + }, + "events": { + "description": "Determines what events the hook is triggered for. Default: ['push'].", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "push", + "pull_request" + ] + }, + "config": { + "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.", + "format": "uri", "examples": [ - true + "https://example.com/webhook" ] }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "examples": [ - true + "\"json\"" ] }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, + "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).", "examples": [ - true + "\"********\"" ] }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true + "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.**", + "examples": [ + "\"0\"" + ] + }, + { + "type": "number" + } ] - }, - "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": { + } + } + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-09-06T20:39:23Z" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-09-06T17:26:27Z" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks/1" + ] + }, + "test_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks/1/test" + ] + }, + "ping_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks/1/pings" + ] + }, + "deliveries_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries" + ] + }, + "last_response": { + "title": "Hook Response", + "type": "object", + "properties": { + "code": { "type": [ - "string", + "integer", "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" ] }, - "created_at": { + "status": { "type": [ "string", "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" ] }, - "updated_at": { + "message": { "type": [ "string", "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } } }, "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" + "code", + "status", + "message" ] + } + }, + "required": [ + "id", + "url", + "type", + "name", + "active", + "events", + "config", + "ping_url", + "created_at", + "updated_at", + "last_response", + "test_url" + ] + }, + "examples": { + "default": { + "value": { + "type": "Repository", + "id": 12345678, + "name": "web", + "active": true, + "events": [ + "push", + "pull_request" + ], + "config": { + "content_type": "json", + "insecure_ssl": "0", + "url": "https://example.com/webhook" + }, + "updated_at": "2019-06-03T00:57:16Z", + "created_at": "2019-06-03T00:57:16Z", + "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", + "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test", + "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings", + "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", + "last_response": { + "code": null, + "status": "unused", + "message": null + } + } + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", + "schema": { + "type": "string" + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "forks": { - "type": "integer" + "documentation_url": { + "type": "string" }, - "master_branch": { + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "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": "repos", + "subcategory": "webhooks" + } + } + }, + "/repos/{owner}/{repo}/hooks/{hook_id}": { + "get": { + "summary": "Get a repository webhook", + "description": "Returns a webhook configured in a repository. To get only the webhook `config` properties, see \"[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository).\"", + "tags": [ + "repos" + ], + "operationId": "repos/get-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook" + }, + "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": "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", + "description": "Webhooks for repositories.", + "type": "object", + "properties": { + "type": { "type": "string" }, - "open_issues": { - "type": "integer" + "id": { + "description": "Unique identifier of the webhook.", + "type": "integer", + "examples": [ + 42 + ] }, - "watchers": { - "type": "integer" + "name": { + "description": "The name of a valid service, use 'web' for a webhook.", + "type": "string", + "examples": [ + "web" + ] }, - "anonymous_access_enabled": { - "description": "Whether anonymous git access is allowed.", - "default": true, - "type": "boolean" + "active": { + "description": "Determines whether the hook is actually triggered on pushes.", + "type": "boolean", + "examples": [ + true + ] }, - "code_of_conduct": { - "title": "Code Of Conduct Simple", - "description": "Code of Conduct Simple", + "events": { + "description": "Determines what events the hook is triggered for. Default: ['push'].", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "push", + "pull_request" + ] + }, + "config": { + "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.", "format": "uri", "examples": [ - "https://api.github.com/repos/github/docs/community/code_of_conduct" + "https://example.com/webhook" ] }, - "key": { + "content_type": { "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "examples": [ - "citizen_code_of_conduct" + "\"json\"" ] }, - "name": { + "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).", "examples": [ - "Citizen Code of Conduct" + "\"********\"" ] }, - "html_url": { + "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.**", + "examples": [ + "\"0\"" + ] + }, + { + "type": "number" + } + ] + } + } + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-09-06T20:39:23Z" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-09-06T17:26:27Z" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks/1" + ] + }, + "test_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks/1/test" + ] + }, + "ping_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks/1/pings" + ] + }, + "deliveries_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries" + ] + }, + "last_response": { + "title": "Hook Response", + "type": "object", + "properties": { + "code": { + "type": [ + "integer", + "null" + ] + }, + "status": { + "type": [ + "string", + "null" + ] + }, + "message": { "type": [ "string", "null" - ], - "format": "uri", - "examples": [ - "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md" ] } }, "required": [ - "url", - "key", - "name", - "html_url" + "code", + "status", + "message" ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" + } + }, + "required": [ + "id", + "url", + "type", + "name", + "active", + "events", + "config", + "ping_url", + "created_at", + "updated_at", + "last_response", + "test_url" + ] + }, + "examples": { + "default": { + "value": { + "type": "Repository", + "id": 12345678, + "name": "web", + "active": true, + "events": [ + "push", + "pull_request" ], - "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" - ] - } + "config": { + "content_type": "json", + "insecure_ssl": "0", + "url": "https://example.com/webhook" + }, + "updated_at": "2019-06-03T00:57:16Z", + "created_at": "2019-06-03T00:57:16Z", + "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", + "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test", + "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings", + "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", + "last_response": { + "code": null, + "status": "unused", + "message": 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" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "webhooks" + } + }, + "patch": { + "summary": "Update a repository webhook", + "description": "Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use \"[Update a webhook configuration for a repository](/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository).\"", + "tags": [ + "repos" + ], + "operationId": "repos/update-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook" + }, + "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": "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, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "config": { + "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.", + "format": "uri", + "examples": [ + "https://example.com/webhook" + ] + }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"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).", + "examples": [ + "\"********\"" + ] + }, + "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.**", + "examples": [ + "\"0\"" + ] + }, + { + "type": "number" } + ] + } + } + }, + "events": { + "type": "array", + "description": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events.", + "default": [ + "push" + ], + "items": { + "type": "string" + } + }, + "add_events": { + "type": "array", + "description": "Determines a list of events to be added to the list of events that the Hook triggers for.", + "items": { + "type": "string" + } + }, + "remove_events": { + "type": "array", + "description": "Determines a list of events to be removed from the list of events that the Hook triggers for.", + "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 + } + } + }, + "examples": { + "default": { + "value": { + "active": true, + "add_events": [ + "pull_request" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Webhook", + "description": "Webhooks for repositories.", + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "id": { + "description": "Unique identifier of the webhook.", + "type": "integer", + "examples": [ + 42 + ] + }, + "name": { + "description": "The name of a valid service, use 'web' for a webhook.", + "type": "string", + "examples": [ + "web" + ] + }, + "active": { + "description": "Determines whether the hook is actually triggered on pushes.", + "type": "boolean", + "examples": [ + true + ] + }, + "events": { + "description": "Determines what events the hook is triggered for. Default: ['push'].", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "push", + "pull_request" + ] + }, + "config": { + "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.", + "format": "uri", + "examples": [ + "https://example.com/webhook" + ] }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"json\"" + ] }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } + "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).", + "examples": [ + "\"********\"" + ] }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { + "insecure_ssl": { + "oneOf": [ + { "type": "string", - "enum": [ - "enabled", - "disabled" + "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.**", + "examples": [ + "\"0\"" ] + }, + { + "type": "number" } - } + ] } } }, - "custom_properties": { + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-09-06T20:39:23Z" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-09-06T17:26:27Z" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks/1" + ] + }, + "test_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks/1/test" + ] + }, + "ping_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks/1/pings" + ] + }, + "deliveries_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries" + ] + }, + "last_response": { + "title": "Hook Response", "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": { + "code": { + "type": [ + "integer", + "null" + ] + }, + "status": { + "type": [ + "string", + "null" + ] + }, + "message": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "code", + "status", + "message" + ] } }, "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_issues", - "has_projects", - "has_wiki", - "has_pages", - "has_discussions", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", + "type", + "name", + "active", + "events", + "config", + "ping_url", "created_at", "updated_at", - "network_count", - "subscribers_count" + "last_response", + "test_url" ] }, "examples": { "default": { "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}", - "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", - "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" - }, - "language": null, - "forks_count": 9, - "forks": 9, - "stargazers_count": 80, - "watchers_count": 80, - "watchers": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "open_issues": 0, - "is_template": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" + "type": "Repository", + "id": 12345678, + "name": "web", + "active": true, + "events": [ + "push", + "pull_request" ], - "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": { - "pull": true, - "push": false, - "admin": false + "config": { + "content_type": "json", + "insecure_ssl": "0", + "url": "https://example.com/webhook" }, - "allow_rebase_merge": true, - "template_repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World-Template", - "full_name": "octocat/Hello-World-Template", - "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 + "updated_at": "2019-06-03T00:57:16Z", + "created_at": "2019-06-03T00:57:16Z", + "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", + "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test", + "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings", + "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", + "last_response": { + "code": null, + "status": "unused", + "message": null + } + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/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": "repos", + "subcategory": "webhooks" + } + }, + "delete": { + "summary": "Delete a repository webhook", + "description": "Delete a webhook for an organization.\n\nThe authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook.", + "tags": [ + "repos" + ], + "operationId": "repos/delete-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook" + }, + "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": "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", + "content": { + "application/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": "repos", + "subcategory": "webhooks" + } + } + }, + "/repos/{owner}/{repo}/hooks/{hook_id}/config": { + "get": { + "summary": "Get a webhook configuration for a repository", + "description": "Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use \"[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/get-webhook-config-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-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": "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.", + "format": "uri", + "examples": [ + "https://example.com/webhook" + ] + }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"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).", + "examples": [ + "\"********\"" + ] + }, + "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.**", + "examples": [ + "\"0\"" + ] }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World-Template", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World-Template", - "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World-Template.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World-Template.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World-Template.git", - "mirror_url": "git:git.example.com/octocat/Hello-World-Template", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World-Template", - "homepage": "https://github.com", - "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" + { + "type": "number" + } + ] + } + } + }, + "examples": { + "default": { + "value": { + "content_type": "json", + "insecure_ssl": "0", + "secret": "********", + "url": "https://example.com/webhook" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "webhooks" + } + }, + "patch": { + "summary": "Update a webhook configuration for a repository", + "description": "Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use \"[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/update-webhook-config-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-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": "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", + "additionalProperties": false, + "properties": { + "url": { + "type": "string", + "description": "The URL to which the payloads will be delivered.", + "format": "uri", + "examples": [ + "https://example.com/webhook" + ] + }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"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).", + "examples": [ + "\"********\"" + ] + }, + "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.**", + "examples": [ + "\"0\"" + ] + }, + { + "type": "number" + } + ] + } + } + }, + "examples": { + "default": { + "summary": "Example of updating content type and URL", + "value": { + "content_type": "json", + "url": "https://example.com/webhook" + } + } + } + } + } + }, + "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.", + "format": "uri", + "examples": [ + "https://example.com/webhook" + ] + }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"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).", + "examples": [ + "\"********\"" + ] + }, + "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.**", + "examples": [ + "\"0\"" + ] }, - "topics": [ - "octocat", - "atom", - "electron", - "api" + { + "type": "number" + } + ] + } + } + }, + "examples": { + "default": { + "value": { + "content_type": "json", + "insecure_ssl": "0", + "secret": "********", + "url": "https://example.com/webhook" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "webhooks" + } + } + }, + "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries": { + "get": { + "summary": "List deliveries for a repository webhook", + "description": "Returns a list of webhook deliveries for a webhook configured in a repository.", + "tags": [ + "repos" + ], + "operationId": "repos/list-webhook-deliveries", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook" + }, + "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": "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" + } + } + ], + "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", + "examples": [ + 42 + ] + }, + "guid": { + "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", + "type": "string", + "examples": [ + "58474f00-b361-11eb-836d-0e4f3503ccbe" + ] + }, + "delivered_at": { + "description": "Time when the webhook delivery occurred.", + "type": "string", + "format": "date-time", + "examples": [ + "2021-05-12T20:33:44Z" + ] + }, + "redelivery": { + "description": "Whether the webhook delivery is a redelivery.", + "type": "boolean", + "examples": [ + false + ] + }, + "duration": { + "description": "Time spent delivering.", + "type": "number", + "examples": [ + 0.03 + ] + }, + "status": { + "description": "Describes the response returned after attempting the delivery.", + "type": "string", + "examples": [ + "failed to connect" + ] + }, + "status_code": { + "description": "Status code received when delivery was made.", + "type": "integer", + "examples": [ + 502 + ] + }, + "event": { + "description": "The event that triggered the delivery.", + "type": "string", + "examples": [ + "issues" + ] + }, + "action": { + "description": "The type of activity for the event that triggered the delivery.", + "type": [ + "string", + "null" ], - "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, - "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 + "examples": [ + "opened" + ] }, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "allow_forking": true, - "web_commit_signoff_required": false, - "subscribers_count": 42, - "network_count": 0, - "organization": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "Organization", - "site_admin": false + "installation_id": { + "description": "The id of the GitHub App installation associated with this event.", + "type": [ + "integer", + "null" + ], + "format": "int64", + "examples": [ + 123 + ] }, - "parent": { - "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" + "repository_id": { + "description": "The id of the repository associated with this event.", + "type": [ + "integer", + "null" ], - "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, - "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://api.github.com/licenses/mit" + "format": "int64", + "examples": [ + 123 + ] + }, + "throttled_at": { + "description": "Time when the webhook delivery was throttled.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2021-05-12T20:33:44Z" + ] + } + }, + "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "webhooks" + } + } + }, + "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}": { + "get": { + "summary": "Get a delivery for a repository webhook", + "description": "Returns a delivery for a webhook configured in a repository.", + "tags": [ + "repos" + ], + "operationId": "repos/get-webhook-delivery", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook" + }, + "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": "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": "Webhook delivery", + "description": "Delivery made by a webhook.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the delivery.", + "type": "integer", + "examples": [ + 42 + ] + }, + "guid": { + "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", + "type": "string", + "examples": [ + "58474f00-b361-11eb-836d-0e4f3503ccbe" + ] + }, + "delivered_at": { + "description": "Time when the delivery was delivered.", + "type": "string", + "format": "date-time", + "examples": [ + "2021-05-12T20:33:44Z" + ] + }, + "redelivery": { + "description": "Whether the delivery is a redelivery.", + "type": "boolean", + "examples": [ + false + ] + }, + "duration": { + "description": "Time spent delivering.", + "type": "number", + "examples": [ + 0.03 + ] + }, + "status": { + "description": "Description of the status of the attempted delivery", + "type": "string", + "examples": [ + "failed to connect" + ] + }, + "status_code": { + "description": "Status code received when delivery was made.", + "type": "integer", + "examples": [ + 502 + ] + }, + "event": { + "description": "The event that triggered the delivery.", + "type": "string", + "examples": [ + "issues" + ] + }, + "action": { + "description": "The type of activity for the event that triggered the delivery.", + "type": [ + "string", + "null" + ], + "examples": [ + "opened" + ] + }, + "installation_id": { + "description": "The id of the GitHub App installation associated with this event.", + "type": [ + "integer", + "null" + ], + "examples": [ + 123 + ] + }, + "repository_id": { + "description": "The id of the repository associated with this event.", + "type": [ + "integer", + "null" + ], + "examples": [ + 123 + ] + }, + "throttled_at": { + "description": "Time when the webhook delivery was throttled.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2021-05-12T20:33:44Z" + ] + }, + "url": { + "description": "The URL target of the delivery.", + "type": "string", + "examples": [ + "https://www.example.com" + ] + }, + "request": { + "type": "object", + "properties": { + "headers": { + "description": "The request headers sent with the webhook delivery.", + "type": [ + "object", + "null" + ], + "additionalProperties": true }, - "forks": 1, - "open_issues": 1, - "watchers": 1 + "payload": { + "description": "The webhook payload.", + "type": [ + "object", + "null" + ], + "additionalProperties": true + } }, - "source": { - "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 + "required": [ + "headers", + "payload" + ] + }, + "response": { + "type": "object", + "properties": { + "headers": { + "description": "The response headers received when the delivery was made.", + "type": [ + "object", + "null" + ], + "additionalProperties": true }, - "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 + "payload": { + "description": "The response payload received.", + "type": [ + "string", + "null" + ], + "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" }, - "allow_rebase_merge": true, - "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://api.github.com/licenses/mit" + "payload": { + "action": "opened", + "issue": { + "body": "foo" + }, + "repository": { + "id": 123 + } + } + }, + "response": { + "headers": { + "Content-Type": "text/html;charset=utf-8" }, - "forks": 1, - "open_issues": 1, - "watchers": 1 + "payload": "ok" } } } @@ -329062,79 +340249,27 @@ } } } - }, - "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": "repos", - "subcategory": "forks" + "subcategory": "webhooks" } } }, - "/repos/{owner}/{repo}/git/blobs": { + "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { "post": { - "summary": "Create a blob", - "description": "", + "summary": "Redeliver a delivery for a repository webhook", + "description": "Redeliver a webhook delivery for a webhook configured in a repository.", "tags": [ - "git" + "repos" ], - "operationId": "git/create-blob", + "operationId": "repos/redeliver-webhook-delivery", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/git/blobs#create-a-blob" + "url": "https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook" }, "parameters": [ { @@ -329154,83 +340289,43 @@ "schema": { "type": "string" } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "content": { - "type": "string", - "description": "The new blob's content." - }, - "encoding": { - "type": "string", - "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", - "default": "utf-8" - } - }, - "required": [ - "content" - ] - }, - "examples": { - "default": { - "value": { - "content": "Content of the blob", - "encoding": "utf-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" + } + }, + { + "name": "delivery_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" } } - }, + ], "responses": { - "201": { - "description": "Response", + "202": { + "description": "Accepted", "content": { "application/json": { "schema": { - "title": "Short Blob", - "description": "Short Blob", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "sha": { - "type": "string" - } - }, - "required": [ - "url", - "sha" - ] + "type": "object" }, "examples": { "default": { - "value": { - "url": "https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15", - "sha": "3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15" - } + "value": null } } } - }, - "headers": { - "Location": { - "example": "https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15", - "schema": { - "type": "string" - } - } } }, - "404": { - "description": "Resource not found", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -329252,43 +340347,63 @@ } } } - } - } - }, - "409": { - "description": "Conflict", - "content": { - "application/json": { + }, + "application/scim+json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Scim Error", + "description": "Scim Error", "type": "object", "properties": { "message": { - "type": "string" + "type": [ + "string", + "null" + ] }, "documentation_url": { - "type": "string" + "type": [ + "string", + "null" + ] }, - "url": { - "type": "string" + "detail": { + "type": [ + "string", + "null" + ] }, "status": { - "type": "string" + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } } } } } } }, - "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" @@ -329296,132 +340411,58 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "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" + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } + { + "type": [ + "integer", + "null" ] - } - } - } - } - } - }, - { - "description": "Repository rule violation was detected", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "status": { - "type": "string" - }, - "metadata": { - "type": "object", - "properties": { - "secret_scanning": { - "type": "object", - "properties": { - "bypass_placeholders": { - "type": "array", - "items": { - "type": "object", - "properties": { - "placeholder_id": { - "description": "The ID of the push protection bypass placeholder. This value is returned on any push protected routes.", - "type": "string" - }, - "token_type": { - "type": "string" - } - } - } + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" } } - } + ] } } } } - ] + } } } } @@ -329430,22 +340471,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "git", - "subcategory": "blobs" + "category": "repos", + "subcategory": "webhooks" } } }, - "/repos/{owner}/{repo}/git/blobs/{file_sha}": { - "get": { - "summary": "Get a blob", - "description": "The `content` in the response will always be Base64 encoded.\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 blob data.\n- **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified.\n\n**Note** This endpoint supports blobs up to 100 megabytes in size.", + "/repos/{owner}/{repo}/hooks/{hook_id}/pings": { + "post": { + "summary": "Ping a repository webhook", + "description": "This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook.", "tags": [ - "git" + "repos" ], - "operationId": "git/get-blob", + "operationId": "repos/ping-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/git/blobs#get-a-blob" + "url": "https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook" }, "parameters": [ { @@ -329467,73 +340508,98 @@ } }, { - "name": "file_sha", + "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": "string" + "type": "integer" } } ], "responses": { - "200": { - "description": "Response", + "204": { + "description": "Response" + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { - "title": "Blob", - "description": "Blob", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "content": { + "message": { "type": "string" }, - "encoding": { + "documentation_url": { "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "sha": { - "type": "string" - }, - "size": { - "type": [ - "integer", - "null" - ] - }, - "node_id": { "type": "string" }, - "highlighted_content": { + "status": { "type": "string" } - }, - "required": [ - "sha", - "url", - "node_id", - "size", - "content", - "encoding" - ] - }, - "examples": { - "default": { - "value": { - "content": "Q29udGVudCBvZiB0aGUgYmxvYg==", - "encoding": "base64", - "url": "https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15", - "sha": "3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15", - "size": 19, - "node_id": "Q29udGVudCBvZiB0aGUgYmxvYg==" - } } } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "webhooks" + } + } + }, + "/repos/{owner}/{repo}/hooks/{hook_id}/tests": { + "post": { + "summary": "Test the push repository webhook", + "description": "This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated.\n\n> [!NOTE]\n> Previously `/repos/:owner/:repo/hooks/:hook_id/test`", + "tags": [ + "repos" + ], + "operationId": "repos/test-push-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook" + }, + "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": "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", @@ -329560,84 +340626,223 @@ } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "webhooks" + } + } + }, + "/repos/{owner}/{repo}/import": { + "get": { + "summary": "Get an import status", + "description": "View the progress of an import.\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).\n\n**Import status**\n\nThis section includes details about the possible values of the `status` field of the Import Progress response.\n\nAn import that does not have errors will progress through these steps:\n\n* `detecting` - the \"detection\" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL.\n* `importing` - the \"raw\" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import).\n* `mapping` - the \"rewrite\" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.\n* `pushing` - the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is \"Writing objects\".\n* `complete` - the import is complete, and the repository is ready on GitHub.\n\nIf there are problems, you will see one of these in the `status` field:\n\n* `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.\n* `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information.\n* `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.\n* `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/rest/migrations/source-imports#start-an-import) with the correct URL.\n* `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.\n\n**The project_choices field**\n\nWhen multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.\n\n**Git LFS related fields**\n\nThis section includes details about Git LFS related fields that may be present in the Import Progress response.\n\n* `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken.\n* `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step.\n* `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository.\n* `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a \"Get Large Files\" request.", + "tags": [ + "migrations" + ], + "operationId": "migrations/get-import-status", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/migrations/source-imports#get-an-import-status" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + { + "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": { - "title": "Validation Error", - "description": "Validation Error", + "title": "Import", + "description": "A repository import from an external source.", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { - "message": { + "vcs": { + "type": [ + "string", + "null" + ] + }, + "use_lfs": { + "type": "boolean" + }, + "vcs_url": { + "description": "The URL of the originating repository.", "type": "string" }, - "documentation_url": { + "svc_root": { "type": "string" }, - "errors": { + "tfvc_project": { + "type": "string" + }, + "status": { + "type": "string", + "enum": [ + "auth", + "error", + "none", + "detecting", + "choose", + "auth_failed", + "importing", + "mapping", + "waiting_to_push", + "pushing", + "complete", + "setup", + "unknown", + "detection_found_multiple", + "detection_found_nothing", + "detection_needs_auth" + ] + }, + "status_text": { + "type": [ + "string", + "null" + ] + }, + "failed_step": { + "type": [ + "string", + "null" + ] + }, + "error_message": { + "type": [ + "string", + "null" + ] + }, + "import_percent": { + "type": [ + "integer", + "null" + ] + }, + "commit_count": { + "type": [ + "integer", + "null" + ] + }, + "push_percent": { + "type": [ + "integer", + "null" + ] + }, + "has_large_files": { + "type": "boolean" + }, + "large_files_size": { + "type": "integer" + }, + "large_files_count": { + "type": "integer" + }, + "project_choices": { "type": "array", "items": { "type": "object", - "required": [ - "code" - ], "properties": { - "resource": { - "type": "string" - }, - "field": { + "vcs": { "type": "string" }, - "message": { + "tfvc_project": { "type": "string" }, - "code": { + "human_name": { "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] } } } + }, + "message": { + "type": "string" + }, + "authors_count": { + "type": [ + "integer", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "authors_url": { + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "svn_root": { + "type": "string" + } + }, + "required": [ + "vcs", + "vcs_url", + "status", + "url", + "repository_url", + "html_url", + "authors_url" + ] + }, + "examples": { + "default": { + "value": { + "vcs": "subversion", + "use_lfs": true, + "vcs_url": "http://svn.mycompany.com/svn/myproject", + "status": "complete", + "status_text": "Done", + "has_large_files": true, + "large_files_size": 132331036, + "large_files_count": 1, + "authors_count": 4, + "url": "https://api.github.com/repos/octocat/socm/import", + "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" } } } } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -329662,8 +340867,8 @@ } } }, - "409": { - "description": "Conflict", + "503": { + "description": "Unavailable due to service under maintenance.", "content": { "application/json": { "schema": { @@ -329692,22 +340897,23 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "git", - "subcategory": "blobs" - } - } - }, - "/repos/{owner}/{repo}/git/commits": { - "post": { - "summary": "Create a commit", - "description": "Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "category": "migrations", + "subcategory": "source-imports", + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12" + }, + "deprecated": true + }, + "put": { + "summary": "Start an import", + "description": "Start a source import to a GitHub repository using GitHub Importer.\nImporting into a GitHub repository with GitHub Actions enabled is not supported and will\nreturn a status `422 Unprocessable Entity` response.\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", "tags": [ - "git" + "migrations" ], - "operationId": "git/create-commit", + "operationId": "migrations/start-import", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/git/commits#create-a-commit" + "url": "https://docs.github.com/rest/migrations/source-imports#start-an-import" }, "parameters": [ { @@ -329736,87 +340942,44 @@ "schema": { "type": "object", "properties": { - "message": { + "vcs_url": { "type": "string", - "description": "The commit message" + "description": "The URL of the originating repository." }, - "tree": { + "vcs": { "type": "string", - "description": "The SHA of the tree object this commit points to" - }, - "parents": { - "type": "array", - "description": "The full SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.", - "items": { - "type": "string" - } - }, - "author": { - "type": "object", - "description": "Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details.", - "properties": { - "name": { - "type": "string", - "description": "The name of the author (or committer) of the commit" - }, - "email": { - "type": "string", - "description": "The email of the author (or committer) of the commit" - }, - "date": { - "type": "string", - "format": "date-time", - "description": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." - } - }, - "required": [ - "name", - "email" + "description": "The originating VCS type. Without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response.", + "enum": [ + "subversion", + "git", + "mercurial", + "tfvc" ] }, - "committer": { - "type": "object", - "description": "Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details.", - "properties": { - "name": { - "type": "string", - "description": "The name of the author (or committer) of the commit" - }, - "email": { - "type": "string", - "description": "The email of the author (or committer) of the commit" - }, - "date": { - "type": "string", - "format": "date-time", - "description": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." - } - } + "vcs_username": { + "type": "string", + "description": "If authentication is required, the username to provide to `vcs_url`." }, - "signature": { + "vcs_password": { "type": "string", - "description": "The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits." + "description": "If authentication is required, the password to provide to `vcs_url`." + }, + "tfvc_project": { + "type": "string", + "description": "For a tfvc import, the name of the project that is being imported." } }, "required": [ - "message", - "tree" + "vcs_url" ] }, "examples": { "default": { "value": { - "message": "my commit message", - "author": { - "name": "Mona Octocat", - "email": "octocat@github.com", - "date": "2008-07-09T16:13:30+12:00" - }, - "parents": [ - "7d1b31e74ee336d15cbd21741bc88a537ed063a0" - ], - "tree": "827efc6d56897b048c772eb4087f854f46256132", - "signature": "-----BEGIN PGP SIGNATURE-----\n\niQIzBAABAQAdFiEESn/54jMNIrGSE6Tp6cQjvhfv7nAFAlnT71cACgkQ6cQjvhfv\n7nCWwA//XVqBKWO0zF+bZl6pggvky3Oc2j1pNFuRWZ29LXpNuD5WUGXGG209B0hI\nDkmcGk19ZKUTnEUJV2Xd0R7AW01S/YSub7OYcgBkI7qUE13FVHN5ln1KvH2all2n\n2+JCV1HcJLEoTjqIFZSSu/sMdhkLQ9/NsmMAzpf/iIM0nQOyU4YRex9eD1bYj6nA\nOQPIDdAuaTQj1gFPHYLzM4zJnCqGdRlg0sOM/zC5apBNzIwlgREatOYQSCfCKV7k\nnrU34X8b9BzQaUx48Qa+Dmfn5KQ8dl27RNeWAqlkuWyv3pUauH9UeYW+KyuJeMkU\n+NyHgAsWFaCFl23kCHThbLStMZOYEnGagrd0hnm1TPS4GJkV4wfYMwnI4KuSlHKB\njHl3Js9vNzEUQipQJbgCgTiWvRJoK3ENwBTMVkKHaqT4x9U4Jk/XZB6Q8MA09ezJ\n3QgiTjTAGcum9E9QiJqMYdWQPWkaBIRRz5cET6HPB48YNXAAUsfmuYsGrnVLYbG+\nUpC6I97VybYHTy2O9XSGoaLeMI9CsFn38ycAxxbWagk5mhclNTP5mezIq6wKSwmr\nX11FW3n1J23fWZn5HJMBsRnUCgzqzX3871IqLYHqRJ/bpZ4h20RhTyPj5c/z7QXp\neSakNQMfbbMcljkha+ZMuVQX1K9aRlVqbmv3ZMWh+OijLYVU2bc=\n=5Io4\n-----END PGP SIGNATURE-----\n" + "vcs": "subversion", + "vcs_url": "http://svn.mycompany.com/svn/myproject", + "vcs_username": "octocat", + "vcs_password": "secret" } } } @@ -329829,235 +340992,168 @@ "content": { "application/json": { "schema": { - "title": "Git Commit", - "description": "Low-level Git commit operations within a repository", + "title": "Import", + "description": "A repository import from an external source.", "type": "object", "properties": { - "sha": { - "description": "SHA for the commit", - "type": "string", - "examples": [ - "7638417db6d59f3c431d3e1f261cc637155684cd" + "vcs": { + "type": [ + "string", + "null" ] }, - "node_id": { + "use_lfs": { + "type": "boolean" + }, + "vcs_url": { + "description": "The URL of the originating repository.", "type": "string" }, - "url": { + "svc_root": { + "type": "string" + }, + "tfvc_project": { + "type": "string" + }, + "status": { "type": "string", - "format": "uri" + "enum": [ + "auth", + "error", + "none", + "detecting", + "choose", + "auth_failed", + "importing", + "mapping", + "waiting_to_push", + "pushing", + "complete", + "setup", + "unknown", + "detection_found_multiple", + "detection_found_nothing", + "detection_needs_auth" + ] }, - "author": { - "description": "Identifying information for the git-user", - "type": "object", - "properties": { - "date": { - "description": "Timestamp of the commit", - "format": "date-time", - "type": "string", - "examples": [ - "2014-08-09T08:02:04+12:00" - ] - }, - "email": { - "type": "string", - "description": "Git email address of the user", - "examples": [ - "monalisa.octocat@example.com" - ] - }, - "name": { - "description": "Name of the git user", - "type": "string", - "examples": [ - "Monalisa Octocat" - ] - } - }, - "required": [ - "email", - "name", - "date" + "status_text": { + "type": [ + "string", + "null" ] }, - "committer": { - "description": "Identifying information for the git-user", - "type": "object", - "properties": { - "date": { - "description": "Timestamp of the commit", - "format": "date-time", - "type": "string", - "examples": [ - "2014-08-09T08:02:04+12:00" - ] - }, - "email": { - "type": "string", - "description": "Git email address of the user", - "examples": [ - "monalisa.octocat@example.com" - ] - }, - "name": { - "description": "Name of the git user", - "type": "string", - "examples": [ - "Monalisa Octocat" - ] - } - }, - "required": [ - "email", - "name", - "date" + "failed_step": { + "type": [ + "string", + "null" ] }, - "message": { - "description": "Message describing the purpose of the commit", - "type": "string", - "examples": [ - "Fix #42" + "error_message": { + "type": [ + "string", + "null" ] }, - "tree": { - "type": "object", - "properties": { - "sha": { - "description": "SHA for the commit", - "type": "string", - "examples": [ - "7638417db6d59f3c431d3e1f261cc637155684cd" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "sha", - "url" + "import_percent": { + "type": [ + "integer", + "null" ] }, - "parents": { + "commit_count": { + "type": [ + "integer", + "null" + ] + }, + "push_percent": { + "type": [ + "integer", + "null" + ] + }, + "has_large_files": { + "type": "boolean" + }, + "large_files_size": { + "type": "integer" + }, + "large_files_count": { + "type": "integer" + }, + "project_choices": { "type": "array", "items": { "type": "object", "properties": { - "sha": { - "description": "SHA for the commit", - "type": "string", - "examples": [ - "7638417db6d59f3c431d3e1f261cc637155684cd" - ] + "vcs": { + "type": "string" }, - "url": { - "type": "string", - "format": "uri" + "tfvc_project": { + "type": "string" }, - "html_url": { - "type": "string", - "format": "uri" + "human_name": { + "type": "string" } - }, - "required": [ - "sha", - "url", - "html_url" - ] + } } }, - "verification": { - "type": "object", - "properties": { - "verified": { - "type": "boolean" - }, - "reason": { - "type": "string" - }, - "signature": { - "type": [ - "string", - "null" - ] - }, - "payload": { - "type": [ - "string", - "null" - ] - }, - "verified_at": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "verified", - "reason", - "signature", - "payload", - "verified_at" + "message": { + "type": "string" + }, + "authors_count": { + "type": [ + "integer", + "null" ] }, + "url": { + "type": "string", + "format": "uri" + }, "html_url": { "type": "string", "format": "uri" + }, + "authors_url": { + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "svn_root": { + "type": "string" } }, "required": [ - "sha", - "node_id", + "vcs", + "vcs_url", + "status", "url", + "repository_url", "html_url", - "author", - "committer", - "tree", - "message", - "parents", - "verification" + "authors_url" ] }, "examples": { "default": { "value": { - "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", - "node_id": "MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==", - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd", - "author": { - "date": "2014-11-07T22:01:45Z", - "name": "Monalisa Octocat", - "email": "octocat@github.com" - }, - "committer": { - "date": "2014-11-07T22:01:45Z", - "name": "Monalisa Octocat", - "email": "octocat@github.com" - }, - "message": "my commit message", - "tree": { - "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/827efc6d56897b048c772eb4087f854f46256132", - "sha": "827efc6d56897b048c772eb4087f854f46256132" - }, - "parents": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7d1b31e74ee336d15cbd21741bc88a537ed063a0", - "sha": "7d1b31e74ee336d15cbd21741bc88a537ed063a0", - "html_url": "https://github.com/octocat/Hello-World/commit/7d1b31e74ee336d15cbd21741bc88a537ed063a0" - } - ], - "verification": { - "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null, - "verified_at": null - }, - "html_url": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" + "vcs": "subversion", + "use_lfs": true, + "vcs_url": "http://svn.mycompany.com/svn/myproject", + "status": "importing", + "status_text": "Importing...", + "has_large_files": false, + "large_files_size": 0, + "large_files_count": 0, + "authors_count": 0, + "commit_count": 1042, + "url": "https://api.github.com/repos/octocat/socm/import", + "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" } } } @@ -330065,7 +341161,7 @@ }, "headers": { "Location": { - "example": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd", + "example": "https://api.github.com/repos/spraints/socm/import", "schema": { "type": "string" } @@ -330173,8 +341269,8 @@ } } }, - "409": { - "description": "Conflict", + "503": { + "description": "Unavailable due to service under maintenance.", "content": { "application/json": { "schema": { @@ -330203,22 +341299,23 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "git", - "subcategory": "commits" - } - } - }, - "/repos/{owner}/{repo}/git/commits/{commit_sha}": { - "get": { - "summary": "Get a commit object", - "description": "Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).\n\nTo get the contents of a commit, see \"[Get a commit](/rest/commits/commits#get-a-commit).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "category": "migrations", + "subcategory": "source-imports", + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12" + }, + "deprecated": true + }, + "patch": { + "summary": "Update an import", + "description": "An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API\nrequest. If no parameters are provided, the import will be restarted.\n\nSome servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will\nhave the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array.\nYou can select the project to import by providing one of the objects in the `project_choices` array in the update request.\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", "tags": [ - "git" + "migrations" ], - "operationId": "git/get-commit", + "operationId": "migrations/update-import", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/git/commits#get-a-commit-object" + "url": "https://docs.github.com/rest/migrations/source-imports#update-an-import" }, "parameters": [ { @@ -330238,459 +341335,353 @@ "schema": { "type": "string" } - }, - { - "name": "commit_sha", - "description": "The SHA of the commit.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true } ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": [ + "object", + "null" + ], + "properties": { + "vcs_username": { + "type": "string", + "description": "The username to provide to the originating repository." + }, + "vcs_password": { + "type": "string", + "description": "The password to provide to the originating repository." + }, + "vcs": { + "type": "string", + "description": "The type of version control system you are migrating from.", + "enum": [ + "subversion", + "tfvc", + "git", + "mercurial" + ], + "examples": [ + "\"git\"" + ] + }, + "tfvc_project": { + "type": "string", + "description": "For a tfvc import, the name of the project that is being imported.", + "examples": [ + "\"project1\"" + ] + } + } + }, + "examples": { + "example-1": { + "summary": "Update authentication for an import", + "value": { + "vcs_username": "octocat", + "vcs_password": "secret" + } + }, + "example-2": { + "summary": "Updating the project choice", + "value": { + "vcs": "tfvc", + "tfvc_project": "project1", + "human_name": "project1 (tfs)" + } + }, + "example-3": { + "summary": "Restarting an import" + } + } + } + } + }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Git Commit", - "description": "Low-level Git commit operations within a repository", + "title": "Import", + "description": "A repository import from an external source.", "type": "object", "properties": { - "sha": { - "description": "SHA for the commit", - "type": "string", - "examples": [ - "7638417db6d59f3c431d3e1f261cc637155684cd" + "vcs": { + "type": [ + "string", + "null" ] }, - "node_id": { + "use_lfs": { + "type": "boolean" + }, + "vcs_url": { + "description": "The URL of the originating repository.", "type": "string" }, - "url": { + "svc_root": { + "type": "string" + }, + "tfvc_project": { + "type": "string" + }, + "status": { "type": "string", - "format": "uri" + "enum": [ + "auth", + "error", + "none", + "detecting", + "choose", + "auth_failed", + "importing", + "mapping", + "waiting_to_push", + "pushing", + "complete", + "setup", + "unknown", + "detection_found_multiple", + "detection_found_nothing", + "detection_needs_auth" + ] }, - "author": { - "description": "Identifying information for the git-user", - "type": "object", - "properties": { - "date": { - "description": "Timestamp of the commit", - "format": "date-time", - "type": "string", - "examples": [ - "2014-08-09T08:02:04+12:00" - ] - }, - "email": { - "type": "string", - "description": "Git email address of the user", - "examples": [ - "monalisa.octocat@example.com" - ] - }, - "name": { - "description": "Name of the git user", - "type": "string", - "examples": [ - "Monalisa Octocat" - ] - } - }, - "required": [ - "email", - "name", - "date" + "status_text": { + "type": [ + "string", + "null" ] }, - "committer": { - "description": "Identifying information for the git-user", - "type": "object", - "properties": { - "date": { - "description": "Timestamp of the commit", - "format": "date-time", - "type": "string", - "examples": [ - "2014-08-09T08:02:04+12:00" - ] - }, - "email": { - "type": "string", - "description": "Git email address of the user", - "examples": [ - "monalisa.octocat@example.com" - ] - }, - "name": { - "description": "Name of the git user", - "type": "string", - "examples": [ - "Monalisa Octocat" - ] - } - }, - "required": [ - "email", - "name", - "date" + "failed_step": { + "type": [ + "string", + "null" ] }, - "message": { - "description": "Message describing the purpose of the commit", - "type": "string", - "examples": [ - "Fix #42" + "error_message": { + "type": [ + "string", + "null" ] }, - "tree": { - "type": "object", - "properties": { - "sha": { - "description": "SHA for the commit", - "type": "string", - "examples": [ - "7638417db6d59f3c431d3e1f261cc637155684cd" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "sha", - "url" + "import_percent": { + "type": [ + "integer", + "null" ] }, - "parents": { + "commit_count": { + "type": [ + "integer", + "null" + ] + }, + "push_percent": { + "type": [ + "integer", + "null" + ] + }, + "has_large_files": { + "type": "boolean" + }, + "large_files_size": { + "type": "integer" + }, + "large_files_count": { + "type": "integer" + }, + "project_choices": { "type": "array", "items": { "type": "object", "properties": { - "sha": { - "description": "SHA for the commit", - "type": "string", - "examples": [ - "7638417db6d59f3c431d3e1f261cc637155684cd" - ] + "vcs": { + "type": "string" }, - "url": { - "type": "string", - "format": "uri" + "tfvc_project": { + "type": "string" }, - "html_url": { - "type": "string", - "format": "uri" + "human_name": { + "type": "string" } - }, - "required": [ - "sha", - "url", - "html_url" - ] + } } }, - "verification": { - "type": "object", - "properties": { - "verified": { - "type": "boolean" - }, - "reason": { - "type": "string" - }, - "signature": { - "type": [ - "string", - "null" - ] - }, - "payload": { - "type": [ - "string", - "null" - ] - }, - "verified_at": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "verified", - "reason", - "signature", - "payload", - "verified_at" + "message": { + "type": "string" + }, + "authors_count": { + "type": [ + "integer", + "null" ] }, + "url": { + "type": "string", + "format": "uri" + }, "html_url": { "type": "string", "format": "uri" + }, + "authors_url": { + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "svn_root": { + "type": "string" } }, "required": [ - "sha", - "node_id", + "vcs", + "vcs_url", + "status", "url", + "repository_url", "html_url", - "author", - "committer", - "tree", - "message", - "parents", - "verification" + "authors_url" ] }, "examples": { - "default": { + "example-1": { + "summary": "Example 1", "value": { - "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", - "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd", - "html_url": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd", - "author": { - "date": "2014-11-07T22:01:45Z", - "name": "Monalisa Octocat", - "email": "octocat@github.com" - }, - "committer": { - "date": "2014-11-07T22:01:45Z", - "name": "Monalisa Octocat", - "email": "octocat@github.com" - }, - "message": "added readme, because im a good github citizen", - "tree": { - "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb", - "sha": "691272480426f78a0138979dd3ce63b77f706feb" - }, - "parents": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5", - "sha": "1acc419d4d6a9ce985db7be48c6349a0475975b5", - "html_url": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" - } - ], - "verification": { - "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null, - "verified_at": 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" + "vcs": "subversion", + "use_lfs": true, + "vcs_url": "http://svn.mycompany.com/svn/myproject", + "status": "detecting", + "url": "https://api.github.com/repos/octocat/socm/import", + "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" } - } - } - } - } - }, - "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" + }, + "example-2": { + "summary": "Example 2", + "value": { + "vcs": "tfvc", + "use_lfs": true, + "vcs_url": "http://tfs.mycompany.com/tfs/myproject", + "tfvc_project": "project1", + "status": "importing", + "status_text": "Importing...", + "has_large_files": false, + "large_files_size": 0, + "large_files_count": 0, + "authors_count": 0, + "commit_count": 1042, + "url": "https://api.github.com/repos/octocat/socm/import", + "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" + } + }, + "example-3": { + "summary": "Response", + "value": { + "vcs": "subversion", + "use_lfs": true, + "vcs_url": "http://svn.mycompany.com/svn/myproject", + "status": "importing", + "status_text": "Importing...", + "has_large_files": false, + "large_files_size": 0, + "large_files_count": 0, + "authors_count": 0, + "commit_count": 1042, + "url": "https://api.github.com/repos/octocat/socm/import", + "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" } } } } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "git", - "subcategory": "commits" - } - } - }, - "/repos/{owner}/{repo}/git/matching-refs/{ref}": { - "get": { - "summary": "List matching references", - "description": "Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array.\n\nWhen you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`.\n\n> [!NOTE]\n> You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nIf you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`.", - "tags": [ - "git" - ], - "operationId": "git/list-matching-refs", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/git/refs#list-matching-references" - }, - "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": "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.", - "in": "path", - "required": true, - "example": "heads/feature-a", - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Git Reference", - "description": "Git references within a repository", - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "object": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "sha": { - "description": "SHA for the reference", - "type": "string", - "minLength": 40, - "maxLength": 40, - "examples": [ - "7638417db6d59f3c431d3e1f261cc637155684cd" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "type", - "sha", - "url" - ] - } - }, - "required": [ - "ref", - "node_id", - "url", - "object" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "ref": "refs/heads/feature-a", - "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlLWE=", - "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-a", - "object": { - "type": "commit", - "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd" - } - }, - { - "ref": "refs/heads/feature-b", - "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlLWI=", - "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-b", - "object": { - "type": "commit", - "sha": "612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac", - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac" - } - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", + } + }, + "503": { + "description": "Unavailable due to service under maintenance.", + "content": { + "application/json": { "schema": { - "type": "string" + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "migrations", + "subcategory": "source-imports", + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12" + }, + "deprecated": true + }, + "delete": { + "summary": "Cancel an import", + "description": "Stop an import for a repository.\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", + "tags": [ + "migrations" + ], + "operationId": "migrations/cancel-import", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/migrations/source-imports#cancel-an-import" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "409": { - "description": "Conflict", + { + "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" + }, + "503": { + "description": "Unavailable due to service under maintenance.", "content": { "application/json": { "schema": { @@ -330719,22 +341710,25 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "git", - "subcategory": "refs" - } + "category": "migrations", + "subcategory": "source-imports", + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12" + }, + "deprecated": true } }, - "/repos/{owner}/{repo}/git/ref/{ref}": { + "/repos/{owner}/{repo}/import/authors": { "get": { - "summary": "Get a reference", - "description": "Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.\n\n> [!NOTE]\n> You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".", + "summary": "Get commit authors", + "description": "Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `.\n\nThis endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information.\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", "tags": [ - "git" + "migrations" ], - "operationId": "git/get-ref", + "operationId": "migrations/get-commit-authors", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/git/refs#get-a-reference" + "url": "https://docs.github.com/rest/migrations/source-imports#get-commit-authors" }, "parameters": [ { @@ -330756,15 +341750,13 @@ } }, { - "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.", - "in": "path", - "required": true, - "example": "heads/feature-a", + "name": "since", + "description": "A user ID. Only return users with an ID greater than this ID.", + "in": "query", + "required": false, "schema": { - "type": "string" - }, - "x-multi-segment": true + "type": "integer" + } } ], "responses": { @@ -330773,66 +341765,78 @@ "content": { "application/json": { "schema": { - "title": "Git Reference", - "description": "Git references within a repository", - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "object": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "sha": { - "description": "SHA for the reference", - "type": "string", - "minLength": 40, - "maxLength": 40, - "examples": [ - "7638417db6d59f3c431d3e1f261cc637155684cd" - ] - }, - "url": { - "type": "string", - "format": "uri" - } + "type": "array", + "items": { + "title": "Porter Author", + "description": "Porter Author", + "type": "object", + "properties": { + "id": { + "type": "integer" }, - "required": [ - "type", - "sha", - "url" - ] - } - }, - "required": [ - "ref", - "node_id", - "url", - "object" - ] + "remote_id": { + "type": "string" + }, + "remote_name": { + "type": "string" + }, + "email": { + "type": "string" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "import_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "remote_id", + "remote_name", + "email", + "name", + "url", + "import_url" + ] + } }, "examples": { "default": { - "value": { - "ref": "refs/heads/featureA", - "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==", - "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA", - "object": { - "type": "commit", - "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd" + "value": [ + { + "id": 2268557, + "remote_id": "nobody@fc7da526-431c-80fe-3c8c-c148ff18d7ef", + "remote_name": "nobody", + "email": "hubot@github.com", + "name": "Hubot", + "url": "https://api.github.com/repos/octocat/socm/import/authors/2268557", + "import_url": "https://api.github.com/repos/octocat/socm/import" + }, + { + "id": 2268558, + "remote_id": "svner@fc7da526-431c-80fe-3c8c-c148ff18d7ef", + "remote_name": "svner", + "email": "svner@fc7da526-431c-80fe-3c8c-c148ff18d7ef", + "name": "svner", + "url": "https://api.github.com/repos/octocat/socm/import/authors/2268558", + "import_url": "https://api.github.com/repos/octocat/socm/import" + }, + { + "id": 2268559, + "remote_id": "svner@example.com@fc7da526-431c-80fe-3c8c-c148ff18d7ef", + "remote_name": "svner@example.com", + "email": "svner@example.com@fc7da526-431c-80fe-3c8c-c148ff18d7ef", + "name": "svner@example.com", + "url": "https://api.github.com/repos/octocat/socm/import/authors/2268559", + "import_url": "https://api.github.com/repos/octocat/socm/import" } - } + ] } } } @@ -330864,8 +341868,8 @@ } } }, - "409": { - "description": "Conflict", + "503": { + "description": "Unavailable due to service under maintenance.", "content": { "application/json": { "schema": { @@ -330894,22 +341898,25 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "git", - "subcategory": "refs" - } + "category": "migrations", + "subcategory": "source-imports", + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12" + }, + "deprecated": true } }, - "/repos/{owner}/{repo}/git/refs": { - "post": { - "summary": "Create a reference", - "description": "Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.", + "/repos/{owner}/{repo}/import/authors/{author_id}": { + "patch": { + "summary": "Map a commit author", + "description": "Update an author's identity for the import. Your application can continue updating authors any time before you push\nnew commits to the repository.\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", "tags": [ - "git" + "migrations" ], - "operationId": "git/create-ref", + "operationId": "migrations/map-commit-author", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/git/refs#create-a-reference" + "url": "https://docs.github.com/rest/migrations/source-imports#map-a-commit-author" }, "parameters": [ { @@ -330929,34 +341936,39 @@ "schema": { "type": "string" } + }, + { + "name": "author_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "requestBody": { - "required": true, + "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { - "ref": { + "email": { "type": "string", - "description": "The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected." + "description": "The new Git author email." }, - "sha": { + "name": { "type": "string", - "description": "The SHA1 value for this reference." + "description": "The new Git author name." } }, - "required": [ - "ref", - "sha" - ] + "additionalProperties": false }, "examples": { "default": { "value": { - "ref": "refs/heads/featureA", - "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd" + "email": "hubot@github.com", + "name": "Hubot the Robot" } } } @@ -330964,82 +341976,63 @@ } }, "responses": { - "201": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Git Reference", - "description": "Git references within a repository", + "title": "Porter Author", + "description": "Porter Author", "type": "object", "properties": { - "ref": { + "id": { + "type": "integer" + }, + "remote_id": { "type": "string" }, - "node_id": { + "remote_name": { + "type": "string" + }, + "email": { + "type": "string" + }, + "name": { "type": "string" }, "url": { "type": "string", "format": "uri" }, - "object": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "sha": { - "description": "SHA for the reference", - "type": "string", - "minLength": 40, - "maxLength": 40, - "examples": [ - "7638417db6d59f3c431d3e1f261cc637155684cd" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "type", - "sha", - "url" - ] + "import_url": { + "type": "string", + "format": "uri" } }, "required": [ - "ref", - "node_id", + "id", + "remote_id", + "remote_name", + "email", + "name", "url", - "object" + "import_url" ] }, "examples": { "default": { "value": { - "ref": "refs/heads/featureA", - "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==", - "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA", - "object": { - "type": "commit", - "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd" - } + "id": 2268557, + "remote_id": "nobody@fc7da526-431c-80fe-3c8c-c148ff18d7ef", + "remote_name": "nobody", + "email": "hubot@github.com", + "name": "Hubot", + "url": "https://api.github.com/repos/octocat/socm/import/authors/2268557", + "import_url": "https://api.github.com/repos/octocat/socm/import" } } } } - }, - "headers": { - "Location": { - "example": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA", - "schema": { - "type": "string" - } - } } }, "422": { @@ -331117,8 +342110,34 @@ } } }, - "409": { - "description": "Conflict", + "404": { + "description": "Resource not found", + "content": { + "application/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": "Unavailable due to service under maintenance.", "content": { "application/json": { "schema": { @@ -331147,22 +342166,25 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "git", - "subcategory": "refs" - } + "category": "migrations", + "subcategory": "source-imports", + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12" + }, + "deprecated": true } }, - "/repos/{owner}/{repo}/git/refs/{ref}": { - "patch": { - "summary": "Update a reference", - "description": "Updates the provided reference to point to a new SHA. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.", + "/repos/{owner}/{repo}/import/large_files": { + "get": { + "summary": "Get large files", + "description": "List files larger than 100MB found during the import\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", "tags": [ - "git" + "migrations" ], - "operationId": "git/update-ref", + "operationId": "migrations/get-large-files", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/git/refs#update-a-reference" + "url": "https://docs.github.com/rest/migrations/source-imports#get-large-files" }, "parameters": [ { @@ -331182,17 +342204,136 @@ "schema": { "type": "string" } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Porter Large File", + "description": "Porter Large File", + "type": "object", + "properties": { + "ref_name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "oid": { + "type": "string" + }, + "size": { + "type": "integer" + } + }, + "required": [ + "oid", + "path", + "ref_name", + "size" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "ref_name": "refs/heads/master", + "path": "foo/bar/1", + "oid": "d3d9446802a44259755d38e6d163e820", + "size": 10485760 + }, + { + "ref_name": "refs/heads/master", + "path": "foo/bar/2", + "oid": "6512bd43d9caa6e02c990b0a82652dca", + "size": 11534336 + }, + { + "ref_name": "refs/heads/master", + "path": "foo/bar/3", + "oid": "c20ad4d76fe97759aa27a0c99bff6710", + "size": 12582912 + } + ] + } + } + } + } + }, + "503": { + "description": "Unavailable due to service under maintenance.", + "content": { + "application/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": "migrations", + "subcategory": "source-imports", + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12" + }, + "deprecated": true + } + }, + "/repos/{owner}/{repo}/import/lfs": { + "patch": { + "summary": "Update Git LFS preference", + "description": "You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability\nis powered by [Git LFS](https://git-lfs.com).\n\nYou can learn more about our LFS feature and working with large files [on our help\nsite](https://docs.github.com/repositories/working-with-files/managing-large-files).\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", + "tags": [ + "migrations" + ], + "operationId": "migrations/set-lfs-preference", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, { - "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.", + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", "in": "path", "required": true, - "example": "heads/feature-a", "schema": { "type": "string" - }, - "x-multi-segment": true + } } ], "requestBody": { @@ -331202,25 +342343,23 @@ "schema": { "type": "object", "properties": { - "sha": { + "use_lfs": { "type": "string", - "description": "The SHA1 value to set this reference to" - }, - "force": { - "type": "boolean", - "description": "Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work.", - "default": false + "description": "Whether to store large files during the import. `opt_in` means large files will be stored using Git LFS. `opt_out` means large files will be removed during the import.", + "enum": [ + "opt_in", + "opt_out" + ] } }, "required": [ - "sha" + "use_lfs" ] }, "examples": { "default": { "value": { - "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", - "force": true + "use_lfs": "opt_in" } } } @@ -331233,65 +342372,167 @@ "content": { "application/json": { "schema": { - "title": "Git Reference", - "description": "Git references within a repository", + "title": "Import", + "description": "A repository import from an external source.", "type": "object", "properties": { - "ref": { + "vcs": { + "type": [ + "string", + "null" + ] + }, + "use_lfs": { + "type": "boolean" + }, + "vcs_url": { + "description": "The URL of the originating repository.", "type": "string" }, - "node_id": { + "svc_root": { "type": "string" }, - "url": { + "tfvc_project": { + "type": "string" + }, + "status": { "type": "string", - "format": "uri" + "enum": [ + "auth", + "error", + "none", + "detecting", + "choose", + "auth_failed", + "importing", + "mapping", + "waiting_to_push", + "pushing", + "complete", + "setup", + "unknown", + "detection_found_multiple", + "detection_found_nothing", + "detection_needs_auth" + ] }, - "object": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "sha": { - "description": "SHA for the reference", - "type": "string", - "minLength": 40, - "maxLength": 40, - "examples": [ - "7638417db6d59f3c431d3e1f261cc637155684cd" - ] - }, - "url": { - "type": "string", - "format": "uri" + "status_text": { + "type": [ + "string", + "null" + ] + }, + "failed_step": { + "type": [ + "string", + "null" + ] + }, + "error_message": { + "type": [ + "string", + "null" + ] + }, + "import_percent": { + "type": [ + "integer", + "null" + ] + }, + "commit_count": { + "type": [ + "integer", + "null" + ] + }, + "push_percent": { + "type": [ + "integer", + "null" + ] + }, + "has_large_files": { + "type": "boolean" + }, + "large_files_size": { + "type": "integer" + }, + "large_files_count": { + "type": "integer" + }, + "project_choices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "vcs": { + "type": "string" + }, + "tfvc_project": { + "type": "string" + }, + "human_name": { + "type": "string" + } } - }, - "required": [ - "type", - "sha", - "url" + } + }, + "message": { + "type": "string" + }, + "authors_count": { + "type": [ + "integer", + "null" ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "authors_url": { + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "svn_root": { + "type": "string" } }, "required": [ - "ref", - "node_id", + "vcs", + "vcs_url", + "status", "url", - "object" + "repository_url", + "html_url", + "authors_url" ] }, "examples": { "default": { "value": { - "ref": "refs/heads/featureA", - "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==", - "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA", - "object": { - "type": "commit", - "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd" - } + "vcs": "subversion", + "use_lfs": true, + "vcs_url": "http://svn.mycompany.com/svn/myproject", + "status": "complete", + "status_text": "Done", + "has_large_files": true, + "large_files_size": 132331036, + "large_files_count": 1, + "authors_count": 4, + "url": "https://api.github.com/repos/octocat/socm/import", + "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" } } } @@ -331373,8 +342614,8 @@ } } }, - "409": { - "description": "Conflict", + "503": { + "description": "Unavailable due to service under maintenance.", "content": { "application/json": { "schema": { @@ -331403,105 +342644,25 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "git", - "subcategory": "refs" - } - }, - "delete": { - "summary": "Delete a reference", - "description": "Deletes the provided reference.", - "tags": [ - "git" - ], - "operationId": "git/delete-ref", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/git/refs#delete-a-reference" - }, - "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": "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.", - "in": "path", - "required": true, - "example": "heads/feature-a", - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "responses": { - "204": { - "description": "Response" - }, - "422": { - "description": "Validation failed, an attempt was made to delete the default branch, or the endpoint has been spammed." - }, - "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" - } - } - } - } - } - } + "category": "migrations", + "subcategory": "source-imports", + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12" }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "git", - "subcategory": "refs" - } + "deprecated": true } }, - "/repos/{owner}/{repo}/git/tags": { - "post": { - "summary": "Create a tag object", - "description": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "/repos/{owner}/{repo}/installation": { + "get": { + "summary": "Get a repository installation for the authenticated app", + "description": "Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.\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": [ - "git" + "apps" ], - "operationId": "git/create-tag", + "operationId": "apps/get-repo-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/git/tags#create-a-tag-object" + "url": "https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app" }, "parameters": [ { @@ -331523,265 +342684,1058 @@ } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "tag": { - "type": "string", - "description": "The tag's name. This is typically a version (e.g., \"v0.0.1\")." - }, - "message": { - "type": "string", - "description": "The tag message." - }, - "object": { - "type": "string", - "description": "The SHA of the git object this is tagging." - }, - "type": { - "type": "string", - "description": "The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`.", - "enum": [ - "commit", - "tree", - "blob" - ] - }, - "tagger": { - "type": "object", - "description": "An object with information about the individual creating the tag.", - "properties": { - "name": { - "type": "string", - "description": "The name of the author of the tag" - }, - "email": { - "type": "string", - "description": "The email of the author of the tag" - }, - "date": { - "type": "string", - "format": "date-time", - "description": "When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." - } - }, - "required": [ - "name", - "email" - ] - } - }, - "required": [ - "tag", - "message", - "object", - "type" - ] - }, - "examples": { - "default": { - "value": { - "tag": "v0.0.1", - "message": "initial version", - "object": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c", - "type": "commit", - "tagger": { - "name": "Monalisa Octocat", - "email": "octocat@github.com", - "date": "2011-06-17T14:53:35-07:00" - } - } - } - } - } - } - }, "responses": { - "201": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Git Tag", - "description": "Metadata for a Git tag", + "title": "Installation", + "description": "Installation", "type": "object", "properties": { - "node_id": { - "type": "string", + "id": { + "description": "The ID of the installation.", + "type": "integer", "examples": [ - "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==" + 1 ] }, - "tag": { - "description": "Name of the tag", + "account": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "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" + ] + } + ], + "type": [ + "null", + "object" + ] + }, + "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", "examples": [ - "v0.0.1" + "https://api.github.com/app/installations/1/access_tokens" ] }, - "sha": { + "repositories_url": { "type": "string", + "format": "uri", "examples": [ - "940bd336248efae0f9ee5bc7b2d5c985887b16ac" + "https://api.github.com/installation/repositories" ] }, - "url": { - "description": "URL for the tag", + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/repositories/42/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac" + "https://github.com/organizations/github/settings/installations/1" ] }, - "message": { - "description": "Message describing the purpose of the tag", + "app_id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "client_id": { "type": "string", "examples": [ - "Initial public release" + "Iv1.ab1112223334445c" ] }, - "tagger": { - "type": "object", - "properties": { - "date": { - "type": "string" - }, - "email": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "required": [ - "date", - "email", - "name" + "target_id": { + "description": "The ID of the user or organization this token is being scoped to.", + "type": "integer" + }, + "target_type": { + "type": "string", + "examples": [ + "Organization" ] }, - "object": { + "permissions": { + "title": "App Permissions", "type": "object", + "description": "The permissions granted to the user access token.", "properties": { - "sha": { - "type": "string" + "actions": { + "type": "string", + "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", + "enum": [ + "read", + "write" + ] }, - "type": { - "type": "string" + "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" + ] }, - "url": { + "checks": { "type": "string", - "format": "uri" - } - }, - "required": [ - "sha", - "type", - "url" - ] - }, - "verification": { - "title": "Verification", - "type": "object", - "properties": { - "verified": { - "type": "boolean" + "description": "The level of permission to grant the access token for checks on code.", + "enum": [ + "read", + "write" + ] }, - "reason": { - "type": "string" + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] }, - "payload": { - "type": [ - "string", - "null" + "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" ] }, - "signature": { - "type": [ - "string", - "null" + "dependabot_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" ] }, - "verified_at": { - "type": [ - "string", - "null" + "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" ] } }, - "required": [ - "verified", - "reason", - "payload", - "signature", - "verified_at" + "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", + "null" + ], + "examples": [ + "config.yaml" + ] + }, + "has_multiple_single_files": { + "type": "boolean", + "examples": [ + true + ] + }, + "single_file_paths": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ] + }, + "app_slug": { + "type": "string", + "examples": [ + "github-actions" + ] + }, + "suspended_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "contact_email": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" ] } }, "required": [ - "sha", - "url", - "node_id", - "tagger", - "object", - "tag", - "message" + "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": { - "node_id": "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==", - "tag": "v0.0.1", - "sha": "940bd336248efae0f9ee5bc7b2d5c985887b16ac", - "url": "https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac", - "message": "initial version", - "tagger": { - "name": "Monalisa Octocat", - "email": "octocat@github.com", - "date": "2014-11-07T22:01:45Z" + "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 }, - "object": { - "type": "commit", - "sha": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c", - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c" + "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" }, - "verification": { - "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null, - "verified_at": null - } + "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 } } } } - }, - "headers": { - "Location": { - "example": "https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac", - "schema": { - "type": "string" - } - } } }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + "301": { + "description": "Moved permanently", "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" @@ -331789,64 +343743,19 @@ "documentation_url": { "type": "string" }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } }, - "409": { - "description": "Conflict", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -331874,23 +343783,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "git", - "subcategory": "tags" + "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "apps" } } }, - "/repos/{owner}/{repo}/git/tags/{tag_sha}": { + "/repos/{owner}/{repo}/interaction-limits": { "get": { - "summary": "Get a tag", - "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "summary": "Get interaction restrictions for a repository", + "description": "Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response.", "tags": [ - "git" + "interactions" ], - "operationId": "git/get-tag", + "operationId": "interactions/get-restrictions-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/git/tags#get-a-tag" + "url": "https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository" }, "parameters": [ { @@ -331910,14 +343819,6 @@ "schema": { "type": "string" } - }, - { - "name": "tag_sha", - "in": "path", - "required": true, - "schema": { - "type": "string" - } } ], "responses": { @@ -331926,208 +343827,57 @@ "content": { "application/json": { "schema": { - "title": "Git Tag", - "description": "Metadata for a Git tag", - "type": "object", - "properties": { - "node_id": { - "type": "string", - "examples": [ - "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==" - ] - }, - "tag": { - "description": "Name of the tag", - "type": "string", - "examples": [ - "v0.0.1" - ] - }, - "sha": { - "type": "string", - "examples": [ - "940bd336248efae0f9ee5bc7b2d5c985887b16ac" - ] - }, - "url": { - "description": "URL for the tag", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac" - ] - }, - "message": { - "description": "Message describing the purpose of the tag", - "type": "string", - "examples": [ - "Initial public release" - ] - }, - "tagger": { - "type": "object", - "properties": { - "date": { - "type": "string" - }, - "email": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "required": [ - "date", - "email", - "name" - ] - }, - "object": { + "anyOf": [ + { + "title": "Interaction Limits", + "description": "Interaction limit settings.", "type": "object", "properties": { - "sha": { - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { + "limit": { "type": "string", - "format": "uri" - } - }, - "required": [ - "sha", - "type", - "url" - ] - }, - "verification": { - "title": "Verification", - "type": "object", - "properties": { - "verified": { - "type": "boolean" - }, - "reason": { - "type": "string" - }, - "payload": { - "type": [ - "string", - "null" + "description": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.", + "enum": [ + "existing_users", + "contributors_only", + "collaborators_only" + ], + "examples": [ + "collaborators_only" ] }, - "signature": { - "type": [ - "string", - "null" + "origin": { + "type": "string", + "examples": [ + "repository" ] }, - "verified_at": { - "type": [ - "string", - "null" + "expires_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-08-17T04:18:39Z" ] } }, "required": [ - "verified", - "reason", - "payload", - "signature", - "verified_at" + "limit", + "origin", + "expires_at" ] + }, + { + "type": "object", + "properties": {}, + "additionalProperties": false } - }, - "required": [ - "sha", - "url", - "node_id", - "tagger", - "object", - "tag", - "message" ] }, "examples": { "default": { "value": { - "node_id": "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==", - "tag": "v0.0.1", - "sha": "940bd336248efae0f9ee5bc7b2d5c985887b16ac", - "url": "https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac", - "message": "initial version", - "tagger": { - "name": "Monalisa Octocat", - "email": "octocat@github.com", - "date": "2014-11-07T22:01:45Z" - }, - "object": { - "type": "commit", - "sha": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c", - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c" - }, - "verification": { - "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null, - "verified_at": 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" - } - } - } - } - } - }, - "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" + "limit": "collaborators_only", + "origin": "repository", + "expires_at": "2018-08-17T04:18:39Z" } } } @@ -332138,22 +343888,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "git", - "subcategory": "tags" + "category": "interactions", + "subcategory": "repos" } - } - }, - "/repos/{owner}/{repo}/git/trees": { - "post": { - "summary": "Create a tree", - "description": "The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.\n\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"[Create a commit](https://docs.github.com/rest/git/commits#create-a-commit)\" and \"[Update a reference](https://docs.github.com/rest/git/refs#update-a-reference).\"\n\nReturns an error if you try to delete a file that does not exist.", + }, + "put": { + "summary": "Set interaction restrictions for a repository", + "description": "Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository.", "tags": [ - "git" + "interactions" ], - "operationId": "git/create-tree", + "operationId": "interactions/set-restrictions-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/git/trees#create-a-tree" + "url": "https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository" }, "parameters": [ { @@ -332180,73 +343928,47 @@ "content": { "application/json": { "schema": { + "title": "Interaction Restrictions", + "description": "Limit interactions to a specific type of user for a specified duration", "type": "object", "properties": { - "tree": { - "type": "array", - "description": "Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure.", - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file referenced in the tree." - }, - "mode": { - "type": "string", - "description": "The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink.", - "enum": [ - "100644", - "100755", - "040000", - "160000", - "120000" - ] - }, - "type": { - "type": "string", - "description": "Either `blob`, `tree`, or `commit`.", - "enum": [ - "blob", - "tree", - "commit" - ] - }, - "sha": { - "type": [ - "string", - "null" - ], - "description": "The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error." - }, - "content": { - "type": "string", - "description": "The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error." - } - } - } + "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.", + "enum": [ + "existing_users", + "contributors_only", + "collaborators_only" + ], + "examples": [ + "collaborators_only" + ] }, - "base_tree": { + "expiry": { "type": "string", - "description": "The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit." + "description": "The duration of the interaction restriction. Default: `one_day`.", + "enum": [ + "one_day", + "three_days", + "one_week", + "one_month", + "six_months" + ], + "examples": [ + "one_month" + ] } }, "required": [ - "tree" + "limit" ] }, "examples": { "default": { + "summary": "Example request body", "value": { - "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312", - "tree": [ - { - "path": "file.rb", - "mode": "100644", - "type": "blob", - "sha": "44b4fc6d56897b048c772eb4087f854f46256132" - } - ] + "limit": "collaborators_only", + "expiry": "one_day" } } } @@ -332254,244 +343976,53 @@ } }, "responses": { - "201": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Git Tree", - "description": "The hierarchy between files in a Git repository.", + "title": "Interaction Limits", + "description": "Interaction limit settings.", "type": "object", "properties": { - "sha": { - "type": "string" - }, - "url": { + "limit": { "type": "string", - "format": "uri" + "description": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.", + "enum": [ + "existing_users", + "contributors_only", + "collaborators_only" + ], + "examples": [ + "collaborators_only" + ] }, - "truncated": { - "type": "boolean" + "origin": { + "type": "string", + "examples": [ + "repository" + ] }, - "tree": { - "description": "Objects specifying a tree structure", - "type": "array", - "items": { - "type": "object", - "required": [ - "path", - "mode", - "type", - "sha" - ], - "properties": { - "path": { - "type": "string", - "examples": [ - "test/file.rb" - ] - }, - "mode": { - "type": "string", - "examples": [ - "040000" - ] - }, - "type": { - "type": "string", - "examples": [ - "tree" - ] - }, - "sha": { - "type": "string", - "examples": [ - "23f6827669e43831def8a7ad935069c8bd418261" - ] - }, - "size": { - "type": "integer", - "examples": [ - 12 - ] - }, - "url": { - "type": "string", - "examples": [ - "https://api.github.com/repos/owner-482f3203ecf01f67e9deb18e/BBB_Private_Repo/git/blobs/23f6827669e43831def8a7ad935069c8bd418261" - ] - } - } - }, + "expires_at": { + "type": "string", + "format": "date-time", "examples": [ - { - "path": "file.rb", - "mode": "100644", - "type": "blob", - "size": 30, - "sha": "44b4fc6d56897b048c772eb4087f854f46256132", - "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132" - } + "2018-08-17T04:18:39Z" ] } }, "required": [ - "sha", - "tree", - "truncated" + "limit", + "origin", + "expires_at" ] }, "examples": { "default": { "value": { - "sha": "cd8274d15fa3ae2ab983129fb037999f264ba9a7", - "url": "https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7", - "tree": [ - { - "path": "file.rb", - "mode": "100644", - "type": "blob", - "size": 132, - "sha": "7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b", - "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b" - } - ], - "truncated": true - } - } - } - } - }, - "headers": { - "Location": { - "example": "https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7", - "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", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "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" - } - } - } - } - } - }, - "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" + "limit": "collaborators_only", + "origin": "repository", + "expires_at": "2018-08-17T04:18:39Z" } } } @@ -332499,51 +344030,26 @@ } }, "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" - } - } - } - } - } + "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "git", - "subcategory": "trees" + "category": "interactions", + "subcategory": "repos" } - } - }, - "/repos/{owner}/{repo}/git/trees/{tree_sha}": { - "get": { - "summary": "Get a tree", - "description": "Returns a single tree using the SHA1 value or ref name for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.\n\n> [!NOTE]\n> The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.", + }, + "delete": { + "summary": "Remove interaction restrictions for a repository", + "description": "Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository.", "tags": [ - "git" + "interactions" ], - "operationId": "git/get-tree", + "operationId": "interactions/remove-restrictions-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/git/trees#get-a-tree" + "url": "https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository" }, "parameters": [ { @@ -332563,318 +344069,35 @@ "schema": { "type": "string" } - }, - { - "name": "tree_sha", - "description": "The SHA1 value or ref (branch or tag) name of the tree.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - }, - { - "name": "recursive", - "description": "Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` to any of the following will enable returning objects or subtrees: `0`, `1`, `\"true\"`, and `\"false\"`. Omit this parameter to prevent recursively returning objects or subtrees.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } } ], "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Git Tree", - "description": "The hierarchy between files in a Git repository.", - "type": "object", - "properties": { - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "truncated": { - "type": "boolean" - }, - "tree": { - "description": "Objects specifying a tree structure", - "type": "array", - "items": { - "type": "object", - "required": [ - "path", - "mode", - "type", - "sha" - ], - "properties": { - "path": { - "type": "string", - "examples": [ - "test/file.rb" - ] - }, - "mode": { - "type": "string", - "examples": [ - "040000" - ] - }, - "type": { - "type": "string", - "examples": [ - "tree" - ] - }, - "sha": { - "type": "string", - "examples": [ - "23f6827669e43831def8a7ad935069c8bd418261" - ] - }, - "size": { - "type": "integer", - "examples": [ - 12 - ] - }, - "url": { - "type": "string", - "examples": [ - "https://api.github.com/repos/owner-482f3203ecf01f67e9deb18e/BBB_Private_Repo/git/blobs/23f6827669e43831def8a7ad935069c8bd418261" - ] - } - } - }, - "examples": [ - { - "path": "file.rb", - "mode": "100644", - "type": "blob", - "size": 30, - "sha": "44b4fc6d56897b048c772eb4087f854f46256132", - "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132" - } - ] - } - }, - "required": [ - "sha", - "tree", - "truncated" - ] - }, - "examples": { - "default-response": { - "summary": "Default response", - "value": { - "sha": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312", - "url": "https://api.github.com/repos/octocat/Hello-World/trees/9fb037999f264ba9a7fc6274d15fa3ae2ab98312", - "tree": [ - { - "path": "file.rb", - "mode": "100644", - "type": "blob", - "size": 30, - "sha": "44b4fc6d56897b048c772eb4087f854f46256132", - "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132" - }, - { - "path": "subdir", - "mode": "040000", - "type": "tree", - "sha": "f484d249c660418515fb01c2b9662073663c242e", - "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/f484d249c660418515fb01c2b9662073663c242e" - }, - { - "path": "exec_file", - "mode": "100755", - "type": "blob", - "size": 75, - "sha": "45b983be36b73c0788dc9cbcb76cbb80fc7bb057", - "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/45b983be36b73c0788dc9cbcb76cbb80fc7bb057" - } - ], - "truncated": false - } - }, - "response-recursively-retrieving-a-tree": { - "summary": "Response recursively retrieving a tree", - "value": { - "sha": "fc6274d15fa3ae2ab983129fb037999f264ba9a7", - "url": "https://api.github.com/repos/octocat/Hello-World/trees/fc6274d15fa3ae2ab983129fb037999f264ba9a7", - "tree": [ - { - "path": "subdir/file.txt", - "mode": "100644", - "type": "blob", - "size": 132, - "sha": "7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b", - "url": "https://api.github.com/repos/octocat/Hello-World/git/7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b" - } - ], - "truncated": false - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/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" }, "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" - } - } - } - } - } + "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "git", - "subcategory": "trees" + "category": "interactions", + "subcategory": "repos" } } }, - "/repos/{owner}/{repo}/hooks": { + "/repos/{owner}/{repo}/invitations": { "get": { - "summary": "List repository webhooks", - "description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.", + "summary": "List repository invitations", + "description": "When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.", "tags": [ "repos" ], - "operationId": "repos/list-webhooks", + "operationId": "repos/list-invitations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/webhooks#list-repository-webhooks" + "url": "https://docs.github.com/rest/collaborators/invitations#list-repository-invitations" }, "parameters": [ { @@ -332922,173 +344145,1274 @@ "schema": { "type": "array", "items": { - "title": "Webhook", - "description": "Webhooks for repositories.", + "title": "Repository Invitation", + "description": "Repository invitations let you manage who you collaborate with.", "type": "object", "properties": { - "type": { - "type": "string" - }, "id": { - "description": "Unique identifier of the webhook.", + "description": "Unique identifier of the repository invitation.", "type": "integer", + "format": "int64", "examples": [ 42 ] }, - "name": { - "description": "The name of a valid service, use 'web' for a webhook.", - "type": "string", - "examples": [ - "web" - ] - }, - "active": { - "description": "Determines whether the hook is actually triggered on pushes.", - "type": "boolean", - "examples": [ - true + "repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "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", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# 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", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "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" ] }, - "events": { - "description": "Determines what events the hook is triggered for. Default: ['push'].", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "push", - "pull_request" + "invitee": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } ] }, - "config": { - "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.", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"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).", - "examples": [ - "\"********\"" - ] + "inviter": { + "anyOf": [ + { + "type": "null" }, - "insecure_ssl": { - "oneOf": [ - { + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { "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.**", "examples": [ - "\"0\"" + "octocat" ] }, - { - "type": "number" + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] } - } + ] }, - "updated_at": { + "permissions": { + "description": "The permission associated with the invitation.", "type": "string", - "format": "date-time", + "enum": [ + "read", + "write", + "admin", + "triage", + "maintain" + ], "examples": [ - "2011-09-06T20:39:23Z" + "read" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2011-09-06T17:26:27Z" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks/1" + "2016-06-13T14:52:50-05:00" ] }, - "test_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks/1/test" - ] + "expired": { + "description": "Whether or not the invitation has expired", + "type": "boolean" }, - "ping_url": { + "url": { + "description": "URL for the repository invitation", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks/1/pings" + "https://api.github.com/user/repository-invitations/1" ] }, - "deliveries_url": { + "html_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries" + "https://github.com/octocat/Hello-World/invitations" ] }, - "last_response": { - "title": "Hook Response", - "type": "object", - "properties": { - "code": { - "type": [ - "integer", - "null" - ] - }, - "status": { - "type": [ - "string", - "null" - ] - }, - "message": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "code", - "status", - "message" - ] + "node_id": { + "type": "string" } }, "required": [ "id", + "node_id", + "permissions", + "inviter", + "invitee", + "repository", "url", - "type", - "name", - "active", - "events", - "config", - "ping_url", - "created_at", - "updated_at", - "last_response", - "test_url" + "html_url", + "created_at" ] } }, @@ -333096,30 +345420,121 @@ "default": { "value": [ { - "type": "Repository", - "id": 12345678, - "name": "web", - "active": true, - "events": [ - "push", - "pull_request" - ], - "config": { - "content_type": "json", - "insecure_ssl": "0", - "url": "https://example.com/webhook" + "id": 1, + "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" }, - "updated_at": "2019-06-03T00:57:16Z", - "created_at": "2019-06-03T00:57:16Z", - "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", - "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test", - "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings", - "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", - "last_response": { - "code": null, - "status": "unused", - "message": null - } + "invitee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "inviter": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "permissions": "write", + "created_at": "2016-06-13T14:52:50-05:00", + "url": "https://api.github.com/user/repository_invitations/1296269", + "html_url": "https://github.com/octocat/Hello-World/invitations", + "node_id": "MDQ6VXNlcjE=" } ] } @@ -333134,51 +345549,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": "repos", - "subcategory": "webhooks" + "category": "collaborators", + "subcategory": "invitations" } - }, - "post": { - "summary": "Create a repository webhook", - "description": "Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can\nshare the same `config` as long as those webhooks do not have any `events` that overlap.", + } + }, + "/repos/{owner}/{repo}/invitations/{invitation_id}": { + "patch": { + "summary": "Update a repository invitation", + "description": "", "tags": [ "repos" ], - "operationId": "repos/create-webhook", + "operationId": "repos/update-invitation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook" + "url": "https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation" }, "parameters": [ { @@ -333198,6 +345589,15 @@ "schema": { "type": "string" } + }, + { + "name": "invitation_id", + "description": "The unique identifier of the invitation.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "requestBody": { @@ -333205,89 +345605,26 @@ "content": { "application/json": { "schema": { - "type": [ - "object", - "null" - ], + "type": "object", "properties": { - "name": { + "permissions": { "type": "string", - "description": "Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `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.", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"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).", - "examples": [ - "\"********\"" - ] - }, - "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.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ] - } - } - }, - "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 + "description": "The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`.", + "enum": [ + "read", + "write", + "maintain", + "triage", + "admin" + ] } - }, - "additionalProperties": false + } }, "examples": { "default": { + "summary": "Example request body", "value": { - "name": "web", - "active": true, - "events": [ - "push", - "pull_request" - ], - "config": { - "url": "https://example.com/webhook", - "content_type": "json", - "insecure_ssl": "0" - } + "permissions": "write" } } } @@ -333295,1077 +345632,1400 @@ } }, "responses": { - "201": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Webhook", - "description": "Webhooks for repositories.", + "title": "Repository Invitation", + "description": "Repository invitations let you manage who you collaborate with.", "type": "object", "properties": { - "type": { - "type": "string" - }, "id": { - "description": "Unique identifier of the webhook.", + "description": "Unique identifier of the repository invitation.", "type": "integer", + "format": "int64", "examples": [ 42 ] }, - "name": { - "description": "The name of a valid service, use 'web' for a webhook.", - "type": "string", - "examples": [ - "web" - ] - }, - "active": { - "description": "Determines whether the hook is actually triggered on pushes.", - "type": "boolean", - "examples": [ - true - ] - }, - "events": { - "description": "Determines what events the hook is triggered for. Default: ['push'].", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "push", - "pull_request" - ] - }, - "config": { - "title": "Webhook Configuration", - "description": "Configuration object of the webhook", + "repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { - "url": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] + }, + "node_id": { "type": "string", - "description": "The URL to which the payloads will be delivered.", - "format": "uri", "examples": [ - "https://example.com/webhook" + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "content_type": { + "name": { "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "examples": [ - "\"json\"" + "Hello-World" ] }, - "secret": { + "full_name": { "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).", "examples": [ - "\"********\"" + "octocat/Hello-World" ] }, - "insecure_ssl": { - "oneOf": [ - { + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { "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.**", "examples": [ - "\"0\"" + "octocat" ] }, - { - "type": "number" + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] - } - } - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-09-06T20:39:23Z" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-09-06T17:26:27Z" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks/1" - ] - }, - "test_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks/1/test" - ] - }, - "ping_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks/1/pings" - ] - }, - "deliveries_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries" - ] - }, - "last_response": { - "title": "Hook Response", - "type": "object", - "properties": { - "code": { + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { "type": [ - "integer", + "string", "null" + ], + "examples": [ + "This your first repo!" ] }, - "status": { + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { "type": [ "string", "null" ] }, - "message": { + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { "type": [ "string", "null" ] - } - }, - "required": [ - "code", - "status", - "message" - ] - } - }, - "required": [ - "id", - "url", - "type", - "name", - "active", - "events", - "config", - "ping_url", - "created_at", - "updated_at", - "last_response", - "test_url" - ] - }, - "examples": { - "default": { - "value": { - "type": "Repository", - "id": 12345678, - "name": "web", - "active": true, - "events": [ - "push", - "pull_request" - ], - "config": { - "content_type": "json", - "insecure_ssl": "0", - "url": "https://example.com/webhook" - }, - "updated_at": "2019-06-03T00:57:16Z", - "created_at": "2019-06-03T00:57:16Z", - "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", - "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test", - "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings", - "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", - "last_response": { - "code": null, - "status": "unused", - "message": null - } - } - } - } - } - }, - "headers": { - "Location": { - "example": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", - "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" - } - } - } - } - } - }, - "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": { + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "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" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "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" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "webhooks" - } - } - }, - "/repos/{owner}/{repo}/hooks/{hook_id}": { - "get": { - "summary": "Get a repository webhook", - "description": "Returns a webhook configured in a repository. To get only the webhook `config` properties, see \"[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository).\"", - "tags": [ - "repos" - ], - "operationId": "repos/get-webhook", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook" - }, - "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": "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", - "description": "Webhooks for repositories.", - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "id": { - "description": "Unique identifier of the webhook.", - "type": "integer", - "examples": [ - 42 - ] - }, - "name": { - "description": "The name of a valid service, use 'web' for a webhook.", - "type": "string", - "examples": [ - "web" - ] - }, - "active": { - "description": "Determines whether the hook is actually triggered on pushes.", - "type": "boolean", - "examples": [ - true - ] - }, - "events": { - "description": "Determines what events the hook is triggered for. Default: ['push'].", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "push", - "pull_request" - ] - }, - "config": { - "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.", - "format": "uri", + }, + "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", + "null" + ], + "format": "date-time", "examples": [ - "https://example.com/webhook" + "2011-01-26T19:06:43Z" ] }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", "examples": [ - "\"json\"" + "2011-01-26T19:01:12Z" ] }, - "secret": { + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { "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).", "examples": [ - "\"********\"" + "admin" ] }, - "insecure_ssl": { - "oneOf": [ - { + "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", - "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.**", "examples": [ - "\"0\"" + "contributor_covenant" ] }, - { - "type": "number" + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# 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", + "null" + ], + "format": "uri" } + }, + "required": [ + "url", + "html_url", + "key", + "name" ] - } - } - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-09-06T20:39:23Z" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-09-06T17:26:27Z" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks/1" - ] - }, - "test_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks/1/test" - ] - }, - "ping_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks/1/pings" - ] - }, - "deliveries_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries" - ] - }, - "last_response": { - "title": "Hook Response", - "type": "object", - "properties": { - "code": { + }, + "license": { "type": [ - "integer", + "object", "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 ] }, - "status": { - "type": [ - "string", - "null" + "open_issues": { + "type": "integer", + "examples": [ + 0 ] }, - "message": { + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { "type": [ - "string", + "object", "null" - ] - } - }, - "required": [ - "code", - "status", - "message" - ] - } - }, - "required": [ - "id", - "url", - "type", - "name", - "active", - "events", - "config", - "ping_url", - "created_at", - "updated_at", - "last_response", - "test_url" - ] - }, - "examples": { - "default": { - "value": { - "type": "Repository", - "id": 12345678, - "name": "web", - "active": true, - "events": [ - "push", - "pull_request" - ], - "config": { - "content_type": "json", - "insecure_ssl": "0", - "url": "https://example.com/webhook" - }, - "updated_at": "2019-06-03T00:57:16Z", - "created_at": "2019-06-03T00:57:16Z", - "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", - "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test", - "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings", - "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", - "last_response": { - "code": null, - "status": "unused", - "message": 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" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "webhooks" - } - }, - "patch": { - "summary": "Update a repository webhook", - "description": "Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use \"[Update a webhook configuration for a repository](/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository).\"", - "tags": [ - "repos" - ], - "operationId": "repos/update-webhook", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook" - }, - "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": "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, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "config": { - "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.", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"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).", - "examples": [ - "\"********\"" - ] - }, - "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.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ] - } - } - }, - "events": { - "type": "array", - "description": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events.", - "default": [ - "push" - ], - "items": { - "type": "string" - } - }, - "add_events": { - "type": "array", - "description": "Determines a list of events to be added to the list of events that the Hook triggers for.", - "items": { - "type": "string" - } - }, - "remove_events": { - "type": "array", - "description": "Determines a list of events to be removed from the list of events that the Hook triggers for.", - "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 - } - } - }, - "examples": { - "default": { - "value": { - "active": true, - "add_events": [ - "pull_request" - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Webhook", - "description": "Webhooks for repositories.", - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "id": { - "description": "Unique identifier of the webhook.", - "type": "integer", - "examples": [ - 42 - ] - }, - "name": { - "description": "The name of a valid service, use 'web' for a webhook.", - "type": "string", - "examples": [ - "web" - ] - }, - "active": { - "description": "Determines whether the hook is actually triggered on pushes.", - "type": "boolean", - "examples": [ - true - ] - }, - "events": { - "description": "Determines what events the hook is triggered for. Default: ['push'].", - "type": "array", - "items": { - "type": "string" + ], + "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 + } }, - "examples": [ - "push", - "pull_request" + "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" ] }, - "config": { - "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.", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"json\"" - ] + "invitee": { + "anyOf": [ + { + "type": "null" }, - "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).", - "examples": [ - "\"********\"" + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] + } + ] + }, + "inviter": { + "anyOf": [ + { + "type": "null" }, - "insecure_ssl": { - "oneOf": [ - { + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { "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.**", "examples": [ - "\"0\"" + "octocat" ] }, - { - "type": "number" + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] } - } + ] }, - "updated_at": { + "permissions": { + "description": "The permission associated with the invitation.", "type": "string", - "format": "date-time", + "enum": [ + "read", + "write", + "admin", + "triage", + "maintain" + ], "examples": [ - "2011-09-06T20:39:23Z" + "read" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2011-09-06T17:26:27Z" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks/1" + "2016-06-13T14:52:50-05:00" ] }, - "test_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks/1/test" - ] + "expired": { + "description": "Whether or not the invitation has expired", + "type": "boolean" }, - "ping_url": { + "url": { + "description": "URL for the repository invitation", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks/1/pings" + "https://api.github.com/user/repository-invitations/1" ] }, - "deliveries_url": { + "html_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries" + "https://github.com/octocat/Hello-World/invitations" ] }, - "last_response": { - "title": "Hook Response", - "type": "object", - "properties": { - "code": { - "type": [ - "integer", - "null" - ] - }, - "status": { - "type": [ - "string", - "null" - ] - }, - "message": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "code", - "status", - "message" - ] + "node_id": { + "type": "string" } }, "required": [ "id", + "node_id", + "permissions", + "inviter", + "invitee", + "repository", "url", - "type", - "name", - "active", - "events", - "config", - "ping_url", - "created_at", - "updated_at", - "last_response", - "test_url" + "html_url", + "created_at" ] }, "examples": { "default": { "value": { - "type": "Repository", - "id": 12345678, - "name": "web", - "active": true, - "events": [ - "push", - "pull_request" - ], - "config": { - "content_type": "json", - "insecure_ssl": "0", - "url": "https://example.com/webhook" + "id": 1, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "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" }, - "updated_at": "2019-06-03T00:57:16Z", - "created_at": "2019-06-03T00:57:16Z", - "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", - "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test", - "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings", - "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", - "last_response": { - "code": null, - "status": "unused", - "message": null - } - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "invitee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "inviter": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "permissions": "write", + "created_at": "2016-06-13T14:52:50-05:00", + "expired": false, + "url": "https://api.github.com/user/repository_invitations/1296269", + "html_url": "https://github.com/octocat/Hello-World/invitations" } } } @@ -334376,20 +347036,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "webhooks" + "category": "collaborators", + "subcategory": "invitations" } }, "delete": { - "summary": "Delete a repository webhook", - "description": "Delete a webhook for an organization.\n\nThe authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook.", + "summary": "Delete a repository invitation", + "description": "", "tags": [ "repos" ], - "operationId": "repos/delete-webhook", + "operationId": "repos/delete-invitation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook" + "url": "https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation" }, "parameters": [ { @@ -334411,8 +347071,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.", + "name": "invitation_id", + "description": "The unique identifier of the invitation.", "in": "path", "required": true, "schema": { @@ -334423,53 +347083,27 @@ "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": "repos", - "subcategory": "webhooks" + "category": "collaborators", + "subcategory": "invitations" } } }, - "/repos/{owner}/{repo}/hooks/{hook_id}/config": { + "/repos/{owner}/{repo}/issues": { "get": { - "summary": "Get a webhook configuration for a repository", - "description": "Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use \"[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint.", + "summary": "List repository issues", + "description": "List issues in a repository. Only open issues will be listed.\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": [ - "repos" + "issues" ], - "operationId": "repos/get-webhook-config-for-repo", + "operationId": "issues/list-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository" + "url": "https://docs.github.com/rest/issues/issues#list-repository-issues" }, "parameters": [ { @@ -334491,290 +347125,111 @@ } }, { - "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": "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 are accepted. If the string `none` is passed, issues without milestones are returned.", + "in": "query", + "required": false, "schema": { - "type": "integer" + "type": "string" } - } - ], - "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.", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"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).", - "examples": [ - "\"********\"" - ] - }, - "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.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ] - } - } - }, - "examples": { - "default": { - "value": { - "content_type": "json", - "insecure_ssl": "0", - "secret": "********", - "url": "https://example.com/webhook" - } - } - } - } + }, + { + "name": "state", + "description": "Indicates the state of the issues to return.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "open", + "closed", + "all" + ], + "default": "open" } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "webhooks" - } - }, - "patch": { - "summary": "Update a webhook configuration for a repository", - "description": "Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use \"[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint.", - "tags": [ - "repos" - ], - "operationId": "repos/update-webhook-config-for-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository" - }, - "parameters": [ + }, { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, + "name": "assignee", + "description": "Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user.", + "in": "query", + "required": false, "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, + "name": "type", + "description": "Can be the name of an issue type. If the string `*` is passed, issues with any type are accepted. If the string `none` is passed, issues without type are returned.", + "in": "query", + "required": false, "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, + "name": "creator", + "description": "The user that created the issue.", + "in": "query", + "required": false, "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": false, - "properties": { - "url": { - "type": "string", - "description": "The URL to which the payloads will be delivered.", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"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).", - "examples": [ - "\"********\"" - ] - }, - "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.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ] - } - } - }, - "examples": { - "default": { - "summary": "Example of updating content type and URL", - "value": { - "content_type": "json", - "url": "https://example.com/webhook" - } - } - } - } - } - }, - "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.", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"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).", - "examples": [ - "\"********\"" - ] - }, - "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.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ] - } - } - }, - "examples": { - "default": { - "value": { - "content_type": "json", - "insecure_ssl": "0", - "secret": "********", - "url": "https://example.com/webhook" - } - } - } - } + "type": "string" } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "webhooks" - } - } - }, - "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries": { - "get": { - "summary": "List deliveries for a repository webhook", - "description": "Returns a list of webhook deliveries for a webhook configured in a repository.", - "tags": [ - "repos" - ], - "operationId": "repos/list-webhook-deliveries", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook" - }, - "parameters": [ + }, { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, + "name": "mentioned", + "description": "A user that's mentioned in the issue.", + "in": "query", + "required": false, "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, + "name": "labels", + "description": "A list of comma separated label names. Example: `bug,ui,@high`", + "in": "query", + "required": false, "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, + "name": "sort", + "description": "What to sort results by.", + "in": "query", + "required": false, "schema": { - "type": "integer" + "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" } }, { @@ -334787,12 +347242,12 @@ } }, { - "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.", + "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 } } ], @@ -334804,2294 +347259,2805 @@ "schema": { "type": "array", "items": { - "title": "Simple webhook delivery", - "description": "Delivery made by a webhook, without request and response information.", + "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 webhook delivery.", "type": "integer", - "format": "int64", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/1" + ] + }, + "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", + "type": "integer", "examples": [ 42 ] }, - "guid": { - "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", + "state": { + "description": "State of the issue; either 'open' or 'closed'", "type": "string", "examples": [ - "58474f00-b361-11eb-836d-0e4f3503ccbe" + "open" ] }, - "delivered_at": { - "description": "Time when the webhook delivery occurred.", + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate", + null + ], + "examples": [ + "not_planned" + ] + }, + "title": { + "description": "Title of the issue", "type": "string", - "format": "date-time", "examples": [ - "2021-05-12T20:33:44Z" + "Widget creation fails in Safari on OS X 10.8" ] }, - "redelivery": { - "description": "Whether the webhook delivery is a redelivery.", - "type": "boolean", + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ], "examples": [ - false + "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?" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "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", + "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", + "null" + ] + }, + "color": { + "type": [ + "string", + "null" + ] + }, + "default": { + "type": "boolean" + } + } + } + ] + }, + "examples": [ + "bug", + "registration" + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "assignees": { + "type": [ + "array", + "null" + ], + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string", + "examples": [ + "v1.0" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] + } + }, + "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" + ] + } ] }, - "duration": { - "description": "Time spent delivering.", - "type": "number", - "examples": [ - 0.03 - ] + "locked": { + "type": "boolean" }, - "status": { - "description": "Describes the response returned after attempting the delivery.", - "type": "string", - "examples": [ - "failed to connect" + "active_lock_reason": { + "type": [ + "string", + "null" ] }, - "status_code": { - "description": "Status code received when delivery was made.", - "type": "integer", - "examples": [ - 502 - ] + "comments": { + "type": "integer" }, - "event": { - "description": "The event that triggered the delivery.", - "type": "string", - "examples": [ - "issues" + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" ] }, - "action": { - "description": "The type of activity for the event that triggered the delivery.", + "closed_at": { "type": [ "string", "null" ], - "examples": [ - "opened" - ] + "format": "date-time" }, - "installation_id": { - "description": "The id of the GitHub App installation associated with this event.", - "type": [ - "integer", - "null" - ], - "format": "int64", - "examples": [ - 123 - ] + "created_at": { + "type": "string", + "format": "date-time" }, - "repository_id": { - "description": "The id of the repository associated with this event.", - "type": [ - "integer", - "null" - ], - "format": "int64", - "examples": [ - 123 + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } ] }, - "throttled_at": { - "description": "Time when the webhook delivery was throttled.", + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", "type": [ - "string", + "object", "null" ], - "format": "date-time", - "examples": [ - "2021-05-12T20:33:44Z" + "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", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "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" ] - } - }, - "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", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "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": { + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", - "required": [ - "code" - ], "properties": { - "resource": { - "type": "string" + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] }, - "field": { - "type": "string" + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] }, - "message": { - "type": "string" + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] }, - "code": { - "type": "string" + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] }, - "index": { + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { "type": "integer" }, - "value": { - "oneOf": [ - { + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { "type": [ "string", "null" ] }, - { + "email": { "type": [ - "integer", + "string", "null" ] }, - { + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { "type": [ - "array", + "string", "null" ], - "items": { - "type": "string" - } + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "webhooks" - } - } - }, - "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}": { - "get": { - "summary": "Get a delivery for a repository webhook", - "description": "Returns a delivery for a webhook configured in a repository.", - "tags": [ - "repos" - ], - "operationId": "repos/get-webhook-delivery", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook" - }, - "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": "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": "Webhook delivery", - "description": "Delivery made by a webhook.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the delivery.", - "type": "integer", - "examples": [ - 42 - ] - }, - "guid": { - "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", - "type": "string", - "examples": [ - "58474f00-b361-11eb-836d-0e4f3503ccbe" - ] - }, - "delivered_at": { - "description": "Time when the delivery was delivered.", - "type": "string", - "format": "date-time", - "examples": [ - "2021-05-12T20:33:44Z" - ] - }, - "redelivery": { - "description": "Whether the delivery is a redelivery.", - "type": "boolean", - "examples": [ - false - ] - }, - "duration": { - "description": "Time spent delivering.", - "type": "number", - "examples": [ - 0.03 - ] - }, - "status": { - "description": "Description of the status of the attempted delivery", - "type": "string", - "examples": [ - "failed to connect" - ] - }, - "status_code": { - "description": "Status code received when delivery was made.", - "type": "integer", - "examples": [ - 502 - ] - }, - "event": { - "description": "The event that triggered the delivery.", - "type": "string", - "examples": [ - "issues" - ] - }, - "action": { - "description": "The type of activity for the event that triggered the delivery.", - "type": [ - "string", - "null" - ], - "examples": [ - "opened" - ] - }, - "installation_id": { - "description": "The id of the GitHub App installation associated with this event.", - "type": [ - "integer", - "null" - ], - "examples": [ - 123 - ] - }, - "repository_id": { - "description": "The id of the repository associated with this event.", - "type": [ - "integer", - "null" - ], - "examples": [ - 123 - ] - }, - "throttled_at": { - "description": "Time when the webhook delivery was throttled.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2021-05-12T20:33:44Z" - ] - }, - "url": { - "description": "The URL target of the delivery.", - "type": "string", - "examples": [ - "https://www.example.com" - ] - }, - "request": { - "type": "object", - "properties": { - "headers": { - "description": "The request headers sent with the webhook delivery.", - "type": [ - "object", - "null" - ], - "additionalProperties": true - }, - "payload": { - "description": "The webhook payload.", - "type": [ - "object", - "null" - ], - "additionalProperties": true - } - }, - "required": [ - "headers", - "payload" - ] - }, - "response": { - "type": "object", - "properties": { - "headers": { - "description": "The response headers received when the delivery was made.", - "type": [ - "object", - "null" - ], - "additionalProperties": true - }, - "payload": { - "description": "The response payload received.", - "type": [ - "string", - "null" - ], - "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", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "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" + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" }, - "field": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] }, - "message": { + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", "type": "string" }, - "code": { + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { "type": "string" }, - "index": { + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { "type": "integer" }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "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" + ] + } ] }, - { - "type": [ - "integer", - "null" + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" ] }, - { + "description": { "type": [ - "array", + "string", "null" ], - "items": { + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" ] } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "webhooks" - } - } - }, - "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { - "post": { - "summary": "Redeliver a delivery for a repository webhook", - "description": "Redeliver a webhook delivery for a webhook configured in a repository.", - "tags": [ - "repos" - ], - "operationId": "repos/redeliver-webhook-delivery", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook" - }, - "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": "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": { - "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", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "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" + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" ], + "examples": [ + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", "properties": { - "resource": { - "type": "string" + "url": { + "type": "string", + "format": "uri" }, - "field": { - "type": "string" + "total_count": { + "type": "integer" }, - "message": { - "type": "string" + "+1": { + "type": "integer" }, - "code": { - "type": "string" + "-1": { + "type": "integer" }, - "index": { + "laugh": { "type": "integer" }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "webhooks" - } - } - }, - "/repos/{owner}/{repo}/hooks/{hook_id}/pings": { - "post": { - "summary": "Ping a repository webhook", - "description": "This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook.", - "tags": [ - "repos" - ], - "operationId": "repos/ping-webhook", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook" - }, - "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": "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", - "content": { - "application/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": "repos", - "subcategory": "webhooks" - } - } - }, - "/repos/{owner}/{repo}/hooks/{hook_id}/tests": { - "post": { - "summary": "Test the push repository webhook", - "description": "This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated.\n\n> [!NOTE]\n> Previously `/repos/:owner/:repo/hooks/:hook_id/test`", - "tags": [ - "repos" - ], - "operationId": "repos/test-push-webhook", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook" - }, - "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": "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", - "content": { - "application/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": "repos", - "subcategory": "webhooks" - } - } - }, - "/repos/{owner}/{repo}/import": { - "get": { - "summary": "Get an import status", - "description": "View the progress of an import.\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).\n\n**Import status**\n\nThis section includes details about the possible values of the `status` field of the Import Progress response.\n\nAn import that does not have errors will progress through these steps:\n\n* `detecting` - the \"detection\" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL.\n* `importing` - the \"raw\" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import).\n* `mapping` - the \"rewrite\" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.\n* `pushing` - the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is \"Writing objects\".\n* `complete` - the import is complete, and the repository is ready on GitHub.\n\nIf there are problems, you will see one of these in the `status` field:\n\n* `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.\n* `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information.\n* `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.\n* `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/rest/migrations/source-imports#start-an-import) with the correct URL.\n* `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.\n\n**The project_choices field**\n\nWhen multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.\n\n**Git LFS related fields**\n\nThis section includes details about Git LFS related fields that may be present in the Import Progress response.\n\n* `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken.\n* `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step.\n* `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository.\n* `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a \"Get Large Files\" request.", - "tags": [ - "migrations" - ], - "operationId": "migrations/get-import-status", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/migrations/source-imports#get-an-import-status" - }, - "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": { - "title": "Import", - "description": "A repository import from an external source.", - "type": "object", - "properties": { - "vcs": { - "type": [ - "string", - "null" - ] - }, - "use_lfs": { - "type": "boolean" - }, - "vcs_url": { - "description": "The URL of the originating repository.", - "type": "string" - }, - "svc_root": { - "type": "string" - }, - "tfvc_project": { - "type": "string" - }, - "status": { - "type": "string", - "enum": [ - "auth", - "error", - "none", - "detecting", - "choose", - "auth_failed", - "importing", - "mapping", - "waiting_to_push", - "pushing", - "complete", - "setup", - "unknown", - "detection_found_multiple", - "detection_found_nothing", - "detection_needs_auth" - ] - }, - "status_text": { - "type": [ - "string", - "null" - ] - }, - "failed_step": { - "type": [ - "string", - "null" - ] - }, - "error_message": { - "type": [ - "string", - "null" - ] - }, - "import_percent": { - "type": [ - "integer", - "null" - ] - }, - "commit_count": { - "type": [ - "integer", - "null" - ] - }, - "push_percent": { - "type": [ - "integer", - "null" - ] - }, - "has_large_files": { - "type": "boolean" - }, - "large_files_size": { - "type": "integer" - }, - "large_files_count": { - "type": "integer" - }, - "project_choices": { - "type": "array", - "items": { - "type": "object", - "properties": { - "vcs": { - "type": "string" + "confused": { + "type": "integer" }, - "tfvc_project": { - "type": "string" + "heart": { + "type": "integer" }, - "human_name": { - "type": "string" - } - } - } - }, - "message": { - "type": "string" - }, - "authors_count": { - "type": [ - "integer", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "authors_url": { - "type": "string", - "format": "uri" - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "svn_root": { - "type": "string" - } - }, - "required": [ - "vcs", - "vcs_url", - "status", - "url", - "repository_url", - "html_url", - "authors_url" - ] - }, - "examples": { - "default": { - "value": { - "vcs": "subversion", - "use_lfs": true, - "vcs_url": "http://svn.mycompany.com/svn/myproject", - "status": "complete", - "status_text": "Done", - "has_large_files": true, - "large_files_size": 132331036, - "large_files_count": 1, - "authors_count": 4, - "url": "https://api.github.com/repos/octocat/socm/import", - "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" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/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": "Unavailable due to service under maintenance.", - "content": { - "application/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": "migrations", - "subcategory": "source-imports", - "deprecationDate": "2023-10-12", - "removalDate": "2024-04-12" - }, - "deprecated": true - }, - "put": { - "summary": "Start an import", - "description": "Start a source import to a GitHub repository using GitHub Importer.\nImporting into a GitHub repository with GitHub Actions enabled is not supported and will\nreturn a status `422 Unprocessable Entity` response.\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", - "tags": [ - "migrations" - ], - "operationId": "migrations/start-import", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/migrations/source-imports#start-an-import" - }, - "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": { - "vcs_url": { - "type": "string", - "description": "The URL of the originating repository." - }, - "vcs": { - "type": "string", - "description": "The originating VCS type. Without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response.", - "enum": [ - "subversion", - "git", - "mercurial", - "tfvc" - ] - }, - "vcs_username": { - "type": "string", - "description": "If authentication is required, the username to provide to `vcs_url`." - }, - "vcs_password": { - "type": "string", - "description": "If authentication is required, the password to provide to `vcs_url`." - }, - "tfvc_project": { - "type": "string", - "description": "For a tfvc import, the name of the project that is being imported." - } - }, - "required": [ - "vcs_url" - ] - }, - "examples": { - "default": { - "value": { - "vcs": "subversion", - "vcs_url": "http://svn.mycompany.com/svn/myproject", - "vcs_username": "octocat", - "vcs_password": "secret" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Import", - "description": "A repository import from an external source.", - "type": "object", - "properties": { - "vcs": { - "type": [ - "string", - "null" - ] - }, - "use_lfs": { - "type": "boolean" - }, - "vcs_url": { - "description": "The URL of the originating repository.", - "type": "string" - }, - "svc_root": { - "type": "string" - }, - "tfvc_project": { - "type": "string" - }, - "status": { - "type": "string", - "enum": [ - "auth", - "error", - "none", - "detecting", - "choose", - "auth_failed", - "importing", - "mapping", - "waiting_to_push", - "pushing", - "complete", - "setup", - "unknown", - "detection_found_multiple", - "detection_found_nothing", - "detection_needs_auth" - ] - }, - "status_text": { - "type": [ - "string", - "null" - ] - }, - "failed_step": { - "type": [ - "string", - "null" - ] - }, - "error_message": { - "type": [ - "string", - "null" - ] - }, - "import_percent": { - "type": [ - "integer", - "null" - ] - }, - "commit_count": { - "type": [ - "integer", - "null" - ] - }, - "push_percent": { - "type": [ - "integer", - "null" - ] - }, - "has_large_files": { - "type": "boolean" - }, - "large_files_size": { - "type": "integer" - }, - "large_files_count": { - "type": "integer" - }, - "project_choices": { - "type": "array", - "items": { - "type": "object", - "properties": { - "vcs": { - "type": "string" + "hooray": { + "type": "integer" }, - "tfvc_project": { - "type": "string" + "eyes": { + "type": "integer" }, - "human_name": { - "type": "string" + "rocket": { + "type": "integer" } - } - } - }, - "message": { - "type": "string" - }, - "authors_count": { - "type": [ - "integer", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "authors_url": { - "type": "string", - "format": "uri" - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "svn_root": { - "type": "string" - } - }, - "required": [ - "vcs", - "vcs_url", - "status", - "url", - "repository_url", - "html_url", - "authors_url" - ] - }, - "examples": { - "default": { - "value": { - "vcs": "subversion", - "use_lfs": true, - "vcs_url": "http://svn.mycompany.com/svn/myproject", - "status": "importing", - "status_text": "Importing...", - "has_large_files": false, - "large_files_size": 0, - "large_files_count": 0, - "authors_count": 0, - "commit_count": 1042, - "url": "https://api.github.com/repos/octocat/socm/import", - "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" - } - } - } - } - }, - "headers": { - "Location": { - "example": "https://api.github.com/repos/spraints/socm/import", - "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" - ], + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" + "total": { + "type": "integer" }, - "index": { + "completed": { "type": "integer" }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] + "percent_completed": { + "type": "integer" } - } - } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "503": { - "description": "Unavailable due to service under maintenance.", - "content": { - "application/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": "migrations", - "subcategory": "source-imports", - "deprecationDate": "2023-10-12", - "removalDate": "2024-04-12" - }, - "deprecated": true - }, - "patch": { - "summary": "Update an import", - "description": "An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API\nrequest. If no parameters are provided, the import will be restarted.\n\nSome servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will\nhave the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array.\nYou can select the project to import by providing one of the objects in the `project_choices` array in the update request.\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", - "tags": [ - "migrations" - ], - "operationId": "migrations/update-import", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/migrations/source-imports#update-an-import" - }, - "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": false, - "content": { - "application/json": { - "schema": { - "type": [ - "object", - "null" - ], - "properties": { - "vcs_username": { - "type": "string", - "description": "The username to provide to the originating repository." - }, - "vcs_password": { - "type": "string", - "description": "The password to provide to the originating repository." - }, - "vcs": { - "type": "string", - "description": "The type of version control system you are migrating from.", - "enum": [ - "subversion", - "tfvc", - "git", - "mercurial" - ], - "examples": [ - "\"git\"" - ] - }, - "tfvc_project": { - "type": "string", - "description": "For a tfvc import, the name of the project that is being imported.", - "examples": [ - "\"project1\"" - ] - } - } - }, - "examples": { - "example-1": { - "summary": "Update authentication for an import", - "value": { - "vcs_username": "octocat", - "vcs_password": "secret" - } - }, - "example-2": { - "summary": "Updating the project choice", - "value": { - "vcs": "tfvc", - "tfvc_project": "project1", - "human_name": "project1 (tfs)" - } - }, - "example-3": { - "summary": "Restarting an import" - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Import", - "description": "A repository import from an external source.", - "type": "object", - "properties": { - "vcs": { - "type": [ - "string", - "null" - ] - }, - "use_lfs": { - "type": "boolean" - }, - "vcs_url": { - "description": "The URL of the originating repository.", - "type": "string" - }, - "svc_root": { - "type": "string" - }, - "tfvc_project": { - "type": "string" - }, - "status": { - "type": "string", - "enum": [ - "auth", - "error", - "none", - "detecting", - "choose", - "auth_failed", - "importing", - "mapping", - "waiting_to_push", - "pushing", - "complete", - "setup", - "unknown", - "detection_found_multiple", - "detection_found_nothing", - "detection_needs_auth" - ] - }, - "status_text": { - "type": [ - "string", - "null" - ] - }, - "failed_step": { - "type": [ - "string", - "null" - ] - }, - "error_message": { - "type": [ - "string", - "null" - ] - }, - "import_percent": { - "type": [ - "integer", - "null" - ] - }, - "commit_count": { - "type": [ - "integer", - "null" - ] - }, - "push_percent": { - "type": [ - "integer", - "null" - ] - }, - "has_large_files": { - "type": "boolean" - }, - "large_files_size": { - "type": "integer" - }, - "large_files_count": { - "type": "integer" - }, - "project_choices": { - "type": "array", - "items": { + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", "type": "object", "properties": { - "vcs": { - "type": "string" + "blocked_by": { + "type": "integer" }, - "tfvc_project": { - "type": "string" + "blocking": { + "type": "integer" }, - "human_name": { - "type": "string" + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" } - } - } - }, - "message": { - "type": "string" - }, - "authors_count": { - "type": [ - "integer", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "authors_url": { - "type": "string", - "format": "uri" - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "svn_root": { - "type": "string" - } - }, - "required": [ - "vcs", - "vcs_url", - "status", - "url", - "repository_url", - "html_url", - "authors_url" - ] - }, - "examples": { - "example-1": { - "summary": "Example 1", - "value": { - "vcs": "subversion", - "use_lfs": true, - "vcs_url": "http://svn.mycompany.com/svn/myproject", - "status": "detecting", - "url": "https://api.github.com/repos/octocat/socm/import", - "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" - } - }, - "example-2": { - "summary": "Example 2", - "value": { - "vcs": "tfvc", - "use_lfs": true, - "vcs_url": "http://tfs.mycompany.com/tfs/myproject", - "tfvc_project": "project1", - "status": "importing", - "status_text": "Importing...", - "has_large_files": false, - "large_files_size": 0, - "large_files_count": 0, - "authors_count": 0, - "commit_count": 1042, - "url": "https://api.github.com/repos/octocat/socm/import", - "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" - } - }, - "example-3": { - "summary": "Response", - "value": { - "vcs": "subversion", - "use_lfs": true, - "vcs_url": "http://svn.mycompany.com/svn/myproject", - "status": "importing", - "status_text": "Importing...", - "has_large_files": false, - "large_files_size": 0, - "large_files_count": 0, - "authors_count": 0, - "commit_count": 1042, - "url": "https://api.github.com/repos/octocat/socm/import", - "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": { - "description": "Unavailable due to service under maintenance.", - "content": { - "application/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": "migrations", - "subcategory": "source-imports", - "deprecationDate": "2023-10-12", - "removalDate": "2024-04-12" - }, - "deprecated": true - }, - "delete": { - "summary": "Cancel an import", - "description": "Stop an import for a repository.\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", - "tags": [ - "migrations" - ], - "operationId": "migrations/cancel-import", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/migrations/source-imports#cancel-an-import" - }, - "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" - }, - "503": { - "description": "Unavailable due to service under maintenance.", - "content": { - "application/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": "migrations", - "subcategory": "source-imports", - "deprecationDate": "2023-10-12", - "removalDate": "2024-04-12" - }, - "deprecated": true - } - }, - "/repos/{owner}/{repo}/import/authors": { - "get": { - "summary": "Get commit authors", - "description": "Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `.\n\nThis endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information.\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", - "tags": [ - "migrations" - ], - "operationId": "migrations/get-commit-authors", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/migrations/source-imports#get-commit-authors" - }, - "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": "since", - "description": "A user ID. Only return users with an ID greater than this ID.", - "in": "query", - "required": false, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Porter Author", - "description": "Porter Author", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "remote_id": { - "type": "string" - }, - "remote_name": { - "type": "string" - }, - "email": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "import_url": { - "type": "string", - "format": "uri" + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", "id", - "remote_id", - "remote_name", - "email", - "name", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", "url", - "import_url" + "user", + "author_association", + "created_at", + "updated_at" ] } }, @@ -337099,66 +350065,179 @@ "default": { "value": [ { - "id": 2268557, - "remote_id": "nobody@fc7da526-431c-80fe-3c8c-c148ff18d7ef", - "remote_name": "nobody", - "email": "hubot@github.com", - "name": "Hubot", - "url": "https://api.github.com/repos/octocat/socm/import/authors/2268557", - "import_url": "https://api.github.com/repos/octocat/socm/import" - }, - { - "id": 2268558, - "remote_id": "svner@fc7da526-431c-80fe-3c8c-c148ff18d7ef", - "remote_name": "svner", - "email": "svner@fc7da526-431c-80fe-3c8c-c148ff18d7ef", - "name": "svner", - "url": "https://api.github.com/repos/octocat/socm/import/authors/2268558", - "import_url": "https://api.github.com/repos/octocat/socm/import" - }, - { - "id": 2268559, - "remote_id": "svner@example.com@fc7da526-431c-80fe-3c8c-c148ff18d7ef", - "remote_name": "svner@example.com", - "email": "svner@example.com@fc7da526-431c-80fe-3c8c-c148ff18d7ef", - "name": "svner@example.com", - "url": "https://api.github.com/repos/octocat/socm/import/authors/2268559", - "import_url": "https://api.github.com/repos/octocat/socm/import" + "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" } ] } } } - } - }, - "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" } } } }, - "503": { - "description": "Unavailable due to service under maintenance.", + "301": { + "description": "Moved permanently", "content": { "application/json": { "schema": { @@ -337182,147 +350261,6 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "migrations", - "subcategory": "source-imports", - "deprecationDate": "2023-10-12", - "removalDate": "2024-04-12" - }, - "deprecated": true - } - }, - "/repos/{owner}/{repo}/import/authors/{author_id}": { - "patch": { - "summary": "Map a commit author", - "description": "Update an author's identity for the import. Your application can continue updating authors any time before you push\nnew commits to the repository.\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", - "tags": [ - "migrations" - ], - "operationId": "migrations/map-commit-author", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/migrations/source-imports#map-a-commit-author" - }, - "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": "author_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "email": { - "type": "string", - "description": "The new Git author email." - }, - "name": { - "type": "string", - "description": "The new Git author name." - } - }, - "additionalProperties": false - }, - "examples": { - "default": { - "value": { - "email": "hubot@github.com", - "name": "Hubot the Robot" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Porter Author", - "description": "Porter Author", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "remote_id": { - "type": "string" - }, - "remote_name": { - "type": "string" - }, - "email": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "import_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "remote_id", - "remote_name", - "email", - "name", - "url", - "import_url" - ] - }, - "examples": { - "default": { - "value": { - "id": 2268557, - "remote_id": "nobody@fc7da526-431c-80fe-3c8c-c148ff18d7ef", - "remote_name": "nobody", - "email": "hubot@github.com", - "name": "Hubot", - "url": "https://api.github.com/repos/octocat/socm/import/authors/2268557", - "import_url": "https://api.github.com/repos/octocat/socm/import" - } - } - } - } - } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", @@ -337424,56 +350362,25 @@ } } } - }, - "503": { - "description": "Unavailable due to service under maintenance.", - "content": { - "application/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": "migrations", - "subcategory": "source-imports", - "deprecationDate": "2023-10-12", - "removalDate": "2024-04-12" - }, - "deprecated": true - } - }, - "/repos/{owner}/{repo}/import/large_files": { - "get": { - "summary": "Get large files", - "description": "List files larger than 100MB found during the import\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", + "category": "issues", + "subcategory": "issues" + } + }, + "post": { + "summary": "Create an issue", + "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\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).\"\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": [ - "migrations" + "issues" ], - "operationId": "migrations/get-large-files", + "operationId": "issues/create", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/migrations/source-imports#get-large-files" + "url": "https://docs.github.com/rest/issues/issues#create-an-issue" }, "parameters": [ { @@ -337495,160 +350402,119 @@ } } ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Porter Large File", - "description": "Porter Large File", - "type": "object", - "properties": { - "ref_name": { - "type": "string" - }, - "path": { - "type": "string" - }, - "oid": { + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "oneOf": [ + { "type": "string" }, - "size": { + { "type": "integer" } - }, - "required": [ - "oid", - "path", - "ref_name", - "size" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "ref_name": "refs/heads/master", - "path": "foo/bar/1", - "oid": "d3d9446802a44259755d38e6d163e820", - "size": 10485760 - }, + ], + "description": "The title of the issue." + }, + "body": { + "type": "string", + "description": "The contents of the issue." + }, + "assignee": { + "type": [ + "string", + "null" + ], + "description": "Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is closing down.**_" + }, + "milestone": { + "oneOf": [ { - "ref_name": "refs/heads/master", - "path": "foo/bar/2", - "oid": "6512bd43d9caa6e02c990b0a82652dca", - "size": 11534336 + "type": "string" }, { - "ref_name": "refs/heads/master", - "path": "foo/bar/3", - "oid": "c20ad4d76fe97759aa27a0c99bff6710", - "size": 12582912 + "type": "integer", + "description": "The `number` of the milestone to associate this issue with. _NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise._" } + ], + "type": [ + "null", + "string", + "integer" ] - } - } - } - } - }, - "503": { - "description": "Unavailable due to service under maintenance.", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { + }, + "labels": { + "type": "array", + "description": "Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "color": { + "type": [ + "string", + "null" + ] + } + } + } + ] + } + }, + "assignees": { + "type": "array", + "description": "Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", + "items": { "type": "string" } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "migrations", - "subcategory": "source-imports", - "deprecationDate": "2023-10-12", - "removalDate": "2024-04-12" - }, - "deprecated": true - } - }, - "/repos/{owner}/{repo}/import/lfs": { - "patch": { - "summary": "Update Git LFS preference", - "description": "You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability\nis powered by [Git LFS](https://git-lfs.com).\n\nYou can learn more about our LFS feature and working with large files [on our help\nsite](https://docs.github.com/repositories/working-with-files/managing-large-files).\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", - "tags": [ - "migrations" - ], - "operationId": "migrations/set-lfs-preference", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference" - }, - "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": { - "use_lfs": { - "type": "string", - "description": "Whether to store large files during the import. `opt_in` means large files will be stored using Git LFS. `opt_out` means large files will be removed during the import.", - "enum": [ - "opt_in", - "opt_out" + }, + "type": { + "type": [ + "string", + "null" + ], + "description": "The name of the issue type to associate with this issue. _NOTE: Only users with push access can set the type for new issues. The type is silently dropped otherwise._", + "examples": [ + "Epic" ] } }, "required": [ - "use_lfs" + "title" ] }, "examples": { "default": { "value": { - "use_lfs": "opt_in" + "title": "Found a bug", + "body": "I'm having a problem with this.", + "assignees": [ + "octocat" + ], + "milestone": 1, + "labels": [ + "bug" + ] } } } @@ -337656,342 +350522,326 @@ } }, "responses": { - "200": { + "201": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Import", - "description": "A repository import from an external source.", + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { - "vcs": { - "type": [ - "string", - "null" + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/1" ] }, - "use_lfs": { - "type": "boolean" + "repository_url": { + "type": "string", + "format": "uri" }, - "vcs_url": { - "description": "The URL of the originating repository.", + "labels_url": { "type": "string" }, - "svc_root": { - "type": "string" + "comments_url": { + "type": "string", + "format": "uri" }, - "tfvc_project": { - "type": "string" + "events_url": { + "type": "string", + "format": "uri" }, - "status": { + "html_url": { "type": "string", - "enum": [ - "auth", - "error", - "none", - "detecting", - "choose", - "auth_failed", - "importing", - "mapping", - "waiting_to_push", - "pushing", - "complete", - "setup", - "unknown", - "detection_found_multiple", - "detection_found_nothing", - "detection_needs_auth" - ] + "format": "uri" }, - "status_text": { - "type": [ - "string", - "null" + "number": { + "description": "Number uniquely identifying the issue within its repository", + "type": "integer", + "examples": [ + 42 ] }, - "failed_step": { - "type": [ - "string", - "null" + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" ] }, - "error_message": { + "state_reason": { + "description": "The reason for the current state", "type": [ "string", "null" + ], + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate", + null + ], + "examples": [ + "not_planned" ] }, - "import_percent": { - "type": [ - "integer", - "null" - ] - }, - "commit_count": { - "type": [ - "integer", - "null" + "title": { + "description": "Title of the issue", + "type": "string", + "examples": [ + "Widget creation fails in Safari on OS X 10.8" ] }, - "push_percent": { + "body": { + "description": "Contents of the issue", "type": [ - "integer", + "string", "null" + ], + "examples": [ + "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?" ] }, - "has_large_files": { - "type": "boolean" - }, - "large_files_size": { - "type": "integer" - }, - "large_files_count": { - "type": "integer" - }, - "project_choices": { - "type": "array", - "items": { - "type": "object", - "properties": { - "vcs": { - "type": "string" - }, - "tfvc_project": { - "type": "string" + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - "human_name": { - "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" + ] } - } - }, - "message": { - "type": "string" - }, - "authors_count": { - "type": [ - "integer", - "null" ] }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "authors_url": { - "type": "string", - "format": "uri" - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "svn_root": { - "type": "string" - } - }, - "required": [ - "vcs", - "vcs_url", - "status", - "url", - "repository_url", - "html_url", - "authors_url" - ] - }, - "examples": { - "default": { - "value": { - "vcs": "subversion", - "use_lfs": true, - "vcs_url": "http://svn.mycompany.com/svn/myproject", - "status": "complete", - "status_text": "Done", - "has_large_files": true, - "large_files_size": 132331036, - "large_files_count": 1, - "authors_count": 4, - "url": "https://api.github.com/repos/octocat/socm/import", - "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" - } - } - } - } - } - }, - "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": { + "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", "type": "array", "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { + "oneOf": [ + { "type": "string" }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { "type": [ "string", "null" ] }, - { + "color": { "type": [ - "integer", + "string", "null" ] }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } + "default": { + "type": "boolean" } - ] + } } - } - } - } - } - } - } - } - }, - "503": { - "description": "Unavailable due to service under maintenance.", - "content": { - "application/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": "migrations", - "subcategory": "source-imports", - "deprecationDate": "2023-10-12", - "removalDate": "2024-04-12" - }, - "deprecated": true - } - }, - "/repos/{owner}/{repo}/installation": { - "get": { - "summary": "Get a repository installation for the authenticated app", - "description": "Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.\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-repo-installation", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app" - }, - "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": { - "title": "Installation", - "description": "Installation", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", + ] + }, "examples": [ - 1 + "bug", + "registration" ] }, - "account": { + "assignee": { "anyOf": [ + { + "type": "null" + }, { "title": "Simple User", "description": "A GitHub user.", @@ -338159,595 +351009,581 @@ "type", "url" ] + } + ] + }, + "assignees": { + "type": [ + "array", + "null" + ], + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "milestone": { + "anyOf": [ { - "title": "Enterprise", - "description": "An enterprise on GitHub.", + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", "type": "object", "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/enterprises/octo-business" + "https://github.com/octocat/Hello-World/milestones/v1.0" ] }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] }, "id": { - "description": "Unique identifier of the enterprise", "type": "integer", "examples": [ - 42 + 1002604 ] }, "node_id": { "type": "string", "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "MDk6TWlsZXN0b25lMTAwMjYwNA==" ] }, - "name": { - "description": "The name of the enterprise.", + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", "examples": [ - "Octo Business" + "open" ] }, - "slug": { - "description": "The slug url identifier for the enterprise.", + "title": { + "description": "The title of the milestone.", "type": "string", "examples": [ - "octo-business" + "v1.0" ] }, - "created_at": { + "description": { "type": [ "string", "null" ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", "format": "date-time", "examples": [ - "2019-01-26T19:01:12Z" + "2011-04-10T20:09:31Z" ] }, "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ - "2019-01-26T19:14:43Z" + "2013-02-12T13:22:01Z" ] }, - "avatar_url": { - "type": "string", - "format": "uri" + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] } }, "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" + "updated_at" ] } - ], - "type": [ - "null", - "object" - ] - }, - "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", - "examples": [ - "https://api.github.com/app/installations/1/access_tokens" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/installation/repositories" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/organizations/github/settings/installations/1" ] }, - "app_id": { - "type": "integer", - "examples": [ - 1 - ] + "locked": { + "type": "boolean" }, - "client_id": { - "type": "string", - "examples": [ - "Iv1.ab1112223334445c" + "active_lock_reason": { + "type": [ + "string", + "null" ] }, - "target_id": { - "description": "The ID of the user or organization this token is being scoped to.", + "comments": { "type": "integer" }, - "target_type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "permissions": { - "title": "App Permissions", + "pull_request": { "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" - ] + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - "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" - ] + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" }, - "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" - ] + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" }, - "profile": { - "type": "string", - "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", - "enum": [ - "write" - ] + "patch_url": { + "type": [ + "string", + "null" + ], + "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" - ] + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" } }, - "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", - "null" - ], - "examples": [ - "config.yaml" - ] - }, - "has_multiple_single_files": { - "type": "boolean", - "examples": [ - true - ] - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "config.yml", - ".github/issue_TEMPLATE.md" + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" ] }, - "app_slug": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "created_at": { "type": "string", - "examples": [ - "github-actions" - ] + "format": "date-time" }, - "suspended_by": { + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { "anyOf": [ { "type": "null" @@ -338922,2032 +351758,94 @@ } ] }, - "suspended_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "contact_email": { - "type": [ - "string", - "null" - ], - "examples": [ - "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" - ] - } - }, - "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 - } - } - } - } - } - }, - "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": { + "body_html": { "type": "string" }, - "documentation_url": { + "body_text": { "type": "string" }, - "url": { - "type": "string" + "timeline_url": { + "type": "string", + "format": "uri" }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "apps", - "subcategory": "apps" - } - } - }, - "/repos/{owner}/{repo}/interaction-limits": { - "get": { - "summary": "Get interaction restrictions for a repository", - "description": "Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response.", - "tags": [ - "interactions" - ], - "operationId": "interactions/get-restrictions-for-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-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": { - "anyOf": [ - { - "title": "Interaction Limits", - "description": "Interaction limit settings.", - "type": "object", + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], "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.", - "enum": [ - "existing_users", - "contributors_only", - "collaborators_only" - ], - "examples": [ - "collaborators_only" - ] + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." }, - "origin": { + "node_id": { "type": "string", - "examples": [ - "repository" - ] + "description": "The node identifier of the issue type." }, - "expires_at": { + "name": { "type": "string", - "format": "date-time", - "examples": [ - "2018-08-17T04:18:39Z" - ] - } - }, - "required": [ - "limit", - "origin", - "expires_at" - ] - }, - { - "type": "object", - "properties": {}, - "additionalProperties": false - } - ] - }, - "examples": { - "default": { - "value": { - "limit": "collaborators_only", - "origin": "repository", - "expires_at": "2018-08-17T04:18:39Z" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "interactions", - "subcategory": "repos" - } - }, - "put": { - "summary": "Set interaction restrictions for a repository", - "description": "Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository.", - "tags": [ - "interactions" - ], - "operationId": "interactions/set-restrictions-for-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-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": { - "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.", - "enum": [ - "existing_users", - "contributors_only", - "collaborators_only" - ], - "examples": [ - "collaborators_only" - ] - }, - "expiry": { - "type": "string", - "description": "The duration of the interaction restriction. Default: `one_day`.", - "enum": [ - "one_day", - "three_days", - "one_week", - "one_month", - "six_months" - ], - "examples": [ - "one_month" - ] - } - }, - "required": [ - "limit" - ] - }, - "examples": { - "default": { - "summary": "Example request body", - "value": { - "limit": "collaborators_only", - "expiry": "one_day" - } - } - } - } - } - }, - "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.", - "enum": [ - "existing_users", - "contributors_only", - "collaborators_only" - ], - "examples": [ - "collaborators_only" - ] - }, - "origin": { - "type": "string", - "examples": [ - "repository" - ] - }, - "expires_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-08-17T04:18:39Z" - ] - } - }, - "required": [ - "limit", - "origin", - "expires_at" - ] - }, - "examples": { - "default": { - "value": { - "limit": "collaborators_only", - "origin": "repository", - "expires_at": "2018-08-17T04:18:39Z" - } - } - } - } - } - }, - "409": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "interactions", - "subcategory": "repos" - } - }, - "delete": { - "summary": "Remove interaction restrictions for a repository", - "description": "Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository.", - "tags": [ - "interactions" - ], - "operationId": "interactions/remove-restrictions-for-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-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" - }, - "409": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "interactions", - "subcategory": "repos" - } - } - }, - "/repos/{owner}/{repo}/invitations": { - "get": { - "summary": "List repository invitations", - "description": "When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.", - "tags": [ - "repos" - ], - "operationId": "repos/list-invitations", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/collaborators/invitations#list-repository-invitations" - }, - "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": "Repository Invitation", - "description": "Repository invitations let you manage who you collaborate with.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository invitation.", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "repository": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "examples": [ - "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", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# 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", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "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" - ] - }, - "invitee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "inviter": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "permissions": { - "description": "The permission associated with the invitation.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "triage", - "maintain" - ], - "examples": [ - "read" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-06-13T14:52:50-05:00" - ] - }, - "expired": { - "description": "Whether or not the invitation has expired", - "type": "boolean" - }, - "url": { - "description": "URL for the repository invitation", - "type": "string", - "examples": [ - "https://api.github.com/user/repository-invitations/1" - ] - }, - "html_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World/invitations" - ] - }, - "node_id": { - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "permissions", - "inviter", - "invitee", - "repository", - "url", - "html_url", - "created_at" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 1, - "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" - }, - "invitee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "inviter": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "permissions": "write", - "created_at": "2016-06-13T14:52:50-05:00", - "url": "https://api.github.com/user/repository_invitations/1296269", - "html_url": "https://github.com/octocat/Hello-World/invitations", - "node_id": "MDQ6VXNlcjE=" - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "collaborators", - "subcategory": "invitations" - } - } - }, - "/repos/{owner}/{repo}/invitations/{invitation_id}": { - "patch": { - "summary": "Update a repository invitation", - "description": "", - "tags": [ - "repos" - ], - "operationId": "repos/update-invitation", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation" - }, - "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": "invitation_id", - "description": "The unique identifier of the invitation.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "permissions": { - "type": "string", - "description": "The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`.", - "enum": [ - "read", - "write", - "maintain", - "triage", - "admin" - ] - } - } - }, - "examples": { - "default": { - "summary": "Example request body", - "value": { - "permissions": "write" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Repository Invitation", - "description": "Repository invitations let you manage who you collaborate with.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository invitation.", - "type": "integer", - "format": "int64", - "examples": [ - 42 + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "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": "Minimal Repository", - "description": "Minimal Repository", + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", "properties": { "id": { + "description": "Unique identifier of the repository", "type": "integer", "format": "int64", "examples": [ - 1296269 + 42 ] }, "node_id": { @@ -340957,9 +351855,10 @@ ] }, "name": { + "description": "The name of the repository.", "type": "string", "examples": [ - "Hello-World" + "Team Environment" ] }, "full_name": { @@ -340968,6 +351867,96 @@ "octocat/Hello-World" ] }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, "owner": { "title": "Simple User", "description": "A GitHub user.", @@ -341137,6 +352126,8 @@ ] }, "private": { + "description": "Whether the repository is private or public.", + "default": false, "type": "boolean" }, "html_url": { @@ -341273,7 +352264,10 @@ ] }, "git_url": { - "type": "string" + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] }, "issue_comment_url": { "type": "string", @@ -341344,7 +352338,10 @@ ] }, "ssh_url": { - "type": "string" + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] }, "stargazers_url": { "type": "string", @@ -341394,12 +352391,19 @@ ] }, "clone_url": { - "type": "string" + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] }, "mirror_url": { "type": [ "string", "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { @@ -341410,12 +352414,20 @@ ] }, "svn_url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] }, "homepage": { "type": [ "string", "null" + ], + "format": "uri", + "examples": [ + "https://github.com" ] }, "language": { @@ -341425,26 +352437,50 @@ ] }, "forks_count": { - "type": "integer" + "type": "integer", + "examples": [ + 9 + ] }, "stargazers_count": { - "type": "integer" + "type": "integer", + "examples": [ + 80 + ] }, "watchers_count": { - "type": "integer" + "type": "integer", + "examples": [ + 80 + ] }, "size": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" + "type": "integer", + "examples": [ + 108 + ] }, "default_branch": { - "type": "string" + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] }, "open_issues_count": { - "type": "integer" + "type": "integer", + "examples": [ + 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", + "examples": [ + true + ] }, "topics": { "type": "array", @@ -341453,30 +352489,61 @@ } }, "has_issues": { - "type": "boolean" + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_projects": { - "type": "boolean" + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_wiki": { - "type": "boolean" + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_pages": { "type": "boolean" }, "has_downloads": { - "type": "boolean" + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] }, "has_discussions": { - "type": "boolean" + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] }, "archived": { + "description": "Whether the repository is archived.", + "default": false, "type": "boolean" }, "disabled": { - "type": "boolean" + "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": { @@ -341509,238 +352576,136 @@ "2011-01-26T19:14:43Z" ] }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", "examples": [ - "admin" + true ] }, "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", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# 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", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true ] }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - } + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] }, - "forks": { - "type": "integer", + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", "examples": [ - 0 + false ] }, - "open_issues": { - "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", "examples": [ - 0 + false ] }, - "watchers": { - "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 + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", "examples": [ - 0 + true ] }, "allow_forking": { + "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { - "type": "boolean", + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", "examples": [ - false + "\"2020-07-09T00:17:42Z\"" ] }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], + "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": { - "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": [ @@ -341789,3020 +352754,1349 @@ "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" ] }, - "invitee": { + "performed_via_github_app": { "anyOf": [ { "type": "null" }, { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", + "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", + "null" + ], "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { + "description": "Unique identifier of the GitHub app", "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "inviter": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" + 37 ] }, - "login": { + "slug": { + "description": "The slug name of the GitHub app", "type": "string", "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 + "probot-owners" ] }, "node_id": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" + "MDExOkludGVncmF0aW9uMQ==" ] }, - "user_view_type": { + "client_id": { "type": "string", "examples": [ - "public" + "\"Iv1.25b5d1e65ffc4022\"" ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "permissions": { - "description": "The permission associated with the invitation.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "triage", - "maintain" - ], - "examples": [ - "read" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-06-13T14:52:50-05:00" - ] - }, - "expired": { - "description": "Whether or not the invitation has expired", - "type": "boolean" - }, - "url": { - "description": "URL for the repository invitation", - "type": "string", - "examples": [ - "https://api.github.com/user/repository-invitations/1" - ] - }, - "html_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World/invitations" - ] - }, - "node_id": { - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "permissions", - "inviter", - "invitee", - "repository", - "url", - "html_url", - "created_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "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" - }, - "invitee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "inviter": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "permissions": "write", - "created_at": "2016-06-13T14:52:50-05:00", - "expired": false, - "url": "https://api.github.com/user/repository_invitations/1296269", - "html_url": "https://github.com/octocat/Hello-World/invitations" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "collaborators", - "subcategory": "invitations" - } - }, - "delete": { - "summary": "Delete a repository invitation", - "description": "", - "tags": [ - "repos" - ], - "operationId": "repos/delete-invitation", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation" - }, - "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": "invitation_id", - "description": "The unique identifier of the invitation.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "collaborators", - "subcategory": "invitations" - } - } - }, - "/repos/{owner}/{repo}/issues": { - "get": { - "summary": "List repository issues", - "description": "List issues in a repository. Only open issues will be listed.\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-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/issues#list-repository-issues" - }, - "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": "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 are accepted. If the string `none` is passed, issues without milestones are returned.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "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": "assignee", - "description": "Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "type", - "description": "Can be the name of an issue type. If the string `*` is passed, issues with any type are accepted. If the string `none` is passed, issues without type are returned.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "creator", - "description": "The user that created the issue.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "mentioned", - "description": "A user that's mentioned in the issue.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "labels", - "description": "A list of comma separated label names. Example: `bug,ui,@high`", - "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", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/issues/1" - ] - }, - "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", - "type": "integer", - "examples": [ - 42 - ] - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ], - "examples": [ - "not_planned" - ] - }, - "title": { - "description": "Title of the issue", - "type": "string", - "examples": [ - "Widget creation fails in Safari on OS X 10.8" - ] - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ], - "examples": [ - "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?" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "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", - "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", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, - "default": { - "type": "boolean" - } - } - } - ] - }, - "examples": [ - "bug", - "registration" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "assignees": { - "type": [ - "array", - "null" - ], - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "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" + ] + } ] }, - "avatar_url": { + "name": { + "description": "The name of the GitHub app", "type": "string", - "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "Probot Owners" ] }, - "gravatar_id": { + "description": { "type": [ "string", "null" ], "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "The description of the app." ] }, - "url": { + "external_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "https://github.com/apps/super-ci" ] }, - "received_events_url": { + "created_at": { "type": "string", - "format": "uri", + "format": "date-time", "examples": [ - "https://api.github.com/users/octocat/received_events" + "2017-07-08T16:18:44-04:00" ] }, - "type": { + "updated_at": { "type": "string", + "format": "date-time", "examples": [ - "User" + "2017-07-08T16:18:44-04:00" ] }, - "site_admin": { - "type": "boolean" + "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" + } }, - "starred_at": { - "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.", + "type": "array", + "items": { + "type": "string" + }, "examples": [ - "\"2020-07-09T00:17:55Z\"" + "label", + "deployment" ] }, - "user_view_type": { - "type": "string", + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", "examples": [ - "public" + 5 ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" ] } + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "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" + } }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/milestones/v1.0" - ] - }, - "labels_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDk6TWlsZXN0b25lMTAwMjYwNA==" - ] - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "examples": [ - 42 - ] - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open", - "examples": [ - "open" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string", - "examples": [ - "v1.0" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "Tracking milestone for version 1.0" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 4 - ] - }, - "closed_issues": { - "type": "integer", - "examples": [ - 8 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2013-02-12T13:22:01Z" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2012-10-09T23:39:01Z" - ] - } - }, - "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" - ] - } - ] - }, - "locked": { - "type": "boolean" - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "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" + } }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" + "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 }, - "created_at": { - "type": "string", - "format": "date-time" + "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 }, - "updated_at": { - "type": "string", - "format": "date-time" + "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" }, - "draft": { - "type": "boolean" + "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": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "body_html": { - "type": "string" + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false }, - "body_text": { + "author_association": "COLLABORATOR", + "state_reason": "completed" + } + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "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", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "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", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] + } + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "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" }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" + "field": { + "type": "string" }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" + "message": { + "type": "string" }, - "open_issues": { - "type": "integer" + "code": { + "type": "string" }, - "watchers": { + "index": { "type": "integer" }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } ] + } + } + } + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "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": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issues" + } + } + }, + "/repos/{owner}/{repo}/issues/comments": { + "get": { + "summary": "List issue comments for a repository", + "description": "You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request.\n\nBy default, issue 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-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/comments#list-issue-comments-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": "sort", + "description": "The property to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated" + ], + "default": "created" + } + }, + { + "name": "direction", + "description": "Either `asc` or `desc`. Ignored without the `sort` parameter.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "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 Comment", + "description": "Comments provide a way for people to collaborate on an issue.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/comments/1" + ] + }, + "body": { + "description": "Contents of the issue comment", + "type": "string", + "examples": [ + "What version of Safari were you using when you observed this bug?" + ] + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { + "anyOf": [ + { + "type": "null" }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { + { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", - "description": "The status of the code search index for this repository", "properties": { - "lexical_search_ok": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { "type": "boolean" }, - "lexical_commit_sha": { - "type": "string" + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] } - }, - "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" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" ] }, "performed_via_github_app": { @@ -345213,24 +354507,6 @@ } ] }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "OWNER" - ] - }, "reactions": { "title": "Reaction Rollup", "type": "object", @@ -345279,48 +354555,16 @@ "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", + "html_url", + "issue_url", "author_association", + "user", + "url", "created_at", "updated_at" ] @@ -345331,17 +354575,10 @@ "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.", + "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, @@ -345362,130 +354599,10 @@ "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" + "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" } ] } @@ -345501,32 +354618,6 @@ } } }, - "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" - } - } - } - } - } - }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { @@ -345633,19 +354724,21 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "issues" + "subcategory": "comments" } - }, - "post": { - "summary": "Create an issue", - "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\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).\"\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`.", + } + }, + "/repos/{owner}/{repo}/issues/comments/{comment_id}": { + "get": { + "summary": "Get an issue comment", + "description": "You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\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", + "operationId": "issues/get-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/issues#create-an-issue" + "url": "https://docs.github.com/rest/issues/comments#get-an-issue-comment" }, "parameters": [ { @@ -345665,219 +354758,64 @@ "schema": { "type": "string" } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "title": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ], - "description": "The title of the issue." - }, - "body": { - "type": "string", - "description": "The contents of the issue." - }, - "assignee": { - "type": [ - "string", - "null" - ], - "description": "Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is closing down.**_" - }, - "milestone": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer", - "description": "The `number` of the milestone to associate this issue with. _NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise._" - } - ], - "type": [ - "null", - "string", - "integer" - ] - }, - "labels": { - "type": "array", - "description": "Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - } - } - } - ] - } - }, - "assignees": { - "type": "array", - "description": "Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", - "items": { - "type": "string" - } - }, - "type": { - "type": [ - "string", - "null" - ], - "description": "The name of the issue type to associate with this issue. _NOTE: Only users with push access can set the type for new issues. The type is silently dropped otherwise._", - "examples": [ - "Epic" - ] - } - }, - "required": [ - "title" - ] - }, - "examples": { - "default": { - "value": { - "title": "Found a bug", - "body": "I'm having a problem with this.", - "assignees": [ - "octocat" - ], - "milestone": 1, - "labels": [ - "bug" - ] - } - } - } + }, + { + "name": "comment_id", + "description": "The unique identifier of the comment.", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" } } - }, + ], "responses": { - "201": { + "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.", + "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", "type": "integer", - "format": "int64" + "format": "int64", + "examples": [ + 42 + ] }, "node_id": { "type": "string" }, "url": { - "description": "URL for the issue", + "description": "URL for the issue comment", "type": "string", "format": "uri", "examples": [ - "https://api.github.com/repositories/42/issues/1" + "https://api.github.com/repositories/42/issues/comments/1" ] }, - "repository_url": { + "body": { + "description": "Contents of the issue comment", "type": "string", - "format": "uri" + "examples": [ + "What version of Safari were you using when you observed this bug?" + ] }, - "labels_url": { + "body_text": { "type": "string" }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" + "body_html": { + "type": "string" }, "html_url": { "type": "string", "format": "uri" }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ], - "examples": [ - "not_planned" - ] - }, - "title": { - "description": "Title of the issue", - "type": "string", - "examples": [ - "Widget creation fails in Safari on OS X 10.8" - ] - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ], - "examples": [ - "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?" - ] - }, "user": { "anyOf": [ { @@ -346053,56 +354991,698 @@ } ] }, - "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", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "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", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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" + } }, - "node_id": { + "additionalProperties": { "type": "string" }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { + "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.", + "type": "array", + "items": { "type": "string" }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] } - } - ] + }, + "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" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/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" + } + }, + "patch": { + "summary": "Update an issue comment", + "description": "You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\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-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/comments#update-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": { + "body": { + "type": "string", + "description": "The contents of the comment." + } + }, + "required": [ + "body" + ] + }, + "examples": { + "default": { + "value": { + "body": "Me too" + } + } + } + } + } + }, + "responses": { + "200": { + "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", + "type": "integer", + "format": "int64", "examples": [ - "bug", - "registration" + 42 ] }, - "assignee": { + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/comments/1" + ] + }, + "body": { + "description": "Contents of the issue comment", + "type": "string", + "examples": [ + "What version of Safari were you using when you observed this bug?" + ] + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { "anyOf": [ { "type": "null" @@ -346277,263 +355857,83 @@ } ] }, - "assignees": { - "type": [ - "array", - "null" + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" ], - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "examples": [ + "OWNER" + ] }, - "milestone": { + "performed_via_github_app": { "anyOf": [ { "type": "null" }, { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", + "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", + "null" + ], "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/milestones/v1.0" - ] - }, - "labels_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - ] - }, "id": { + "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDk6TWlsZXN0b25lMTAwMjYwNA==" - ] - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "examples": [ - 42 + 37 ] }, - "state": { - "description": "The state of the milestone.", + "slug": { + "description": "The slug name of the GitHub app", "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open", "examples": [ - "open" + "probot-owners" ] }, - "title": { - "description": "The title of the milestone.", + "node_id": { "type": "string", "examples": [ - "v1.0" + "MDExOkludGVncmF0aW9uMQ==" ] }, - "description": { - "type": [ - "string", - "null" - ], + "client_id": { + "type": "string", "examples": [ - "Tracking milestone for version 1.0" + "\"Iv1.25b5d1e65ffc4022\"" ] }, - "creator": { - "anyOf": [ - { - "type": "null" - }, + "owner": { + "oneOf": [ { "title": "Simple User", "description": "A GitHub user.", @@ -346701,154 +356101,932 @@ "type", "url" ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "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" + ] } ] }, - "open_issues": { - "type": "integer", + "name": { + "description": "The name of the GitHub app", + "type": "string", "examples": [ - 4 + "Probot Owners" ] }, - "closed_issues": { - "type": "integer", + "description": { + "type": [ + "string", + "null" + ], "examples": [ - 8 + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2011-04-10T20:09:31Z" + "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2014-03-03T18:58:10Z" + "2017-07-08T16:18:44-04:00" ] }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", + "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.", + "type": "array", + "items": { + "type": "string" + }, "examples": [ - "2013-02-12T13:22:01Z" + "label", + "deployment" ] }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time", + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", "examples": [ - "2012-10-09T23:39:01Z" + 5 ] } }, "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", "id", "node_id", - "labels_url", + "owner", + "name", + "description", + "external_url", "html_url", - "number", - "open_issues", - "state", - "title", - "url", "created_at", - "updated_at" + "updated_at", + "permissions", + "events" ] } ] }, - "locked": { - "type": "boolean" - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { + "reactions": { + "title": "Reaction Rollup", "type": "object", "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], + "url": { + "type": "string", "format": "uri" }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" + "total_count": { + "type": "integer" }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" + "+1": { + "type": "integer" }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" } }, "required": [ - "diff_url", - "html_url", - "patch_url", - "url" + "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" }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" + "documentation_url": { + "type": "string" }, - "created_at": { - "type": "string", - "format": "date-time" + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDg6UmVhY3Rpb24x" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "content": { + "description": "The reaction to use", + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "examples": [ + "heart" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-05-20T20:09:31Z" + ] + } }, - "updated_at": { - "type": "string", - "format": "date-time" + "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" }, - "draft": { - "type": "boolean" + "documentation_url": { + "type": "string" }, - "closed_by": { + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDg6UmVhY3Rpb24x" + ] + }, + "user": { "anyOf": [ { "type": "null" @@ -347023,206 +357201,99 @@ } ] }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { + "content": { + "description": "The reaction to use", "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" ], - "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", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "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." - } + "examples": [ + "heart" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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 }, - "required": [ - "id", - "node_id", - "name", - "description" + "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", + "examples": [ + 1 ] }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] + "node_id": { + "type": "string", + "examples": [ + "MDg6UmVhY3Rpb24x" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" }, - "owner": { + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -347389,708 +357460,1008 @@ "type", "url" ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { + } + ] + }, + "content": { + "description": "The reaction to use", + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "examples": [ + "heart" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" + } + } + } + } + } + } + } + } + }, + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOklzc3VlRXZlbnQx" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/events/1" + ] + }, + "actor": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - "lexical_commit_sha": { - "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" + ] } - } + ] }, - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "owner": { - "oneOf": [ - { + "event": { + "type": "string", + "examples": [ + "closed" + ] + }, + "commit_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "commit_url": { + "type": [ + "string", + "null" + ], + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "issue": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/1" + ] + }, + "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", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate", + null + ], + "examples": [ + "not_planned" + ] + }, + "title": { + "description": "Title of the issue", + "type": "string", + "examples": [ + "Widget creation fails in Safari on OS X 10.8" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ], + "examples": [ + "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?" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "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", + "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", + "null" + ] + }, + "color": { + "type": [ + "string", + "null" + ] + }, + "default": { + "type": "boolean" + } + } + } + ] + }, + "examples": [ + "bug", + "registration" + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "assignees": { + "type": [ + "array", + "null" + ], + "items": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -348237,899 +358608,2721 @@ ] } }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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" + ] + } + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string", + "examples": [ + "v1.0" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] + } + }, + "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" + ] + } + ] + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "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", + "null" + ], + "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", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "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", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] + "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": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "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", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } }, - "avatar_url": { - "type": "string", - "format": "uri" - } + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "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", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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" + "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" + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, - "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.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 - ] - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "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" - ] - }, - "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 + "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" + ] + } + ] }, - "author_association": "COLLABORATOR", - "state_reason": "completed" - } - } - } - } - }, - "headers": { - "Location": { - "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347", - "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", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "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" - } - } - } - } - } - }, - "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": { + "label": { + "title": "Issue Event Label", + "description": "Issue Event Label", "type": "object", - "required": [ - "code" - ], "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" + "name": { + "type": [ + "string", + "null" + ] }, - "message": { - "type": "string" + "color": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "name", + "color" + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" }, - "code": { - "type": "string" + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "assigner": { + "anyOf": [ + { + "type": "null" }, - "index": { - "type": "integer" + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "review_requester": { + "anyOf": [ + { + "type": "null" }, - "value": { - "oneOf": [ - { + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { "type": [ "string", "null" ] }, - { - "type": [ - "integer", - "null" + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" ] }, - { + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { "type": [ - "array", + "string", "null" ], - "items": { - "type": "string" - } + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] } - } - } - } - } - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "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": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "issues" - } - } - }, - "/repos/{owner}/{repo}/issues/comments": { - "get": { - "summary": "List issue comments for a repository", - "description": "You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request.\n\nBy default, issue 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-for-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/comments#list-issue-comments-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": "sort", - "description": "The property to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated" - ], - "default": "created" - } - }, - { - "name": "direction", - "description": "Either `asc` or `desc`. Ignored without the `sort` parameter.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "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 Comment", - "description": "Comments provide a way for people to collaborate on an issue.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the issue comment", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/issues/comments/1" ] }, - "body": { - "description": "Contents of the issue comment", - "type": "string", - "examples": [ - "What version of Safari were you using when you observed this bug?" - ] - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { + "requested_reviewer": { "anyOf": [ { "type": "null" @@ -349304,23 +361497,308 @@ } ] }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" + "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", + "null" + ] + }, + "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", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" ] }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" + "dismissed_review": { + "title": "Issue Event Dismissed Review", + "type": "object", + "properties": { + "state": { + "type": "string" + }, + "review_id": { + "type": "integer" + }, + "dismissal_message": { + "type": [ + "string", + "null" + ] + }, + "dismissal_commit_id": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "state", + "review_id", + "dismissal_message" ] }, - "issue_url": { - "type": "string", - "format": "uri" + "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", @@ -349340,6 +361818,12 @@ "OWNER" ] }, + "lock_reason": { + "type": [ + "string", + "null" + ] + }, "performed_via_github_app": { "anyOf": [ { @@ -349747,67 +362231,17 @@ ] } ] - }, - "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" + "actor", + "event", + "commit_id", + "commit_url", + "created_at" ] } }, @@ -349816,11 +362250,9 @@ "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": { + "node_id": "MDEwOklzc3VlRXZlbnQx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1", + "actor": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -349840,10 +362272,148 @@ "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", - "updated_at": "2011-04-14T16:00:49Z", - "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", - "author_association": "COLLABORATOR" + "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" + } } ] } @@ -349923,392 +362493,1369 @@ "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": "issues", - "subcategory": "comments" - } - } - }, - "/repos/{owner}/{repo}/issues/comments/{comment_id}": { - "get": { - "summary": "Get an issue comment", - "description": "You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\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-comment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/comments#get-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": { - "200": { - "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", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/issues/comments/1" - ] - }, - "body": { - "description": "Contents of the issue comment", - "type": "string", - "examples": [ - "What version of Safari were you using when you observed this bug?" - ] - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" + } + ] + } + } + } + } + } + } + } + } + } + }, + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOklzc3VlRXZlbnQx" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/events/1" + ] + }, + "actor": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "event": { + "type": "string", + "examples": [ + "closed" + ] + }, + "commit_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "commit_url": { + "type": [ + "string", + "null" + ], + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "issue": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/1" + ] + }, + "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", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate", + null + ], + "examples": [ + "not_planned" + ] + }, + "title": { + "description": "Title of the issue", + "type": "string", + "examples": [ + "Widget creation fails in Safari on OS X 10.8" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ], + "examples": [ + "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?" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "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", + "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", + "null" + ] + }, + "color": { + "type": [ + "string", + "null" + ] + }, + "default": { + "type": "boolean" + } + } + } + ] + }, + "examples": [ + "bug", + "registration" + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "assignees": { + "type": [ + "array", + "null" + ], + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string", + "examples": [ + "v1.0" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] + } + }, + "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" + ] + } ] }, - "email": { + "locked": { + "type": "boolean" + }, + "active_lock_reason": { "type": [ "string", "null" ] }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "comments": { + "type": "integer" }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" ] }, - "gravatar_id": { + "closed_at": { "type": [ "string", "null" ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "format": "date-time" }, - "received_events_url": { + "created_at": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] + "format": "date-time" }, - "type": { + "updated_at": { "type": "string", - "examples": [ - "User" - ] + "format": "date-time" }, - "site_admin": { + "draft": { "type": "boolean" }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "OWNER" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "owner": { - "oneOf": [ + "closed_by": { + "anyOf": [ + { + "type": "null" + }, { "title": "Simple User", "description": "A GitHub user.", @@ -350476,454 +364023,1605 @@ "type", "url" ] + } + ] + }, + "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", + "null" + ], + "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", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", + "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", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { "type": "object", "properties": { - "description": { - "description": "A short description of the enterprise.", + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { "type": [ "string", "null" ] }, - "html_url": { + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/enterprises/octo-business" + "https://github.com/images/error/octocat_happy.gif" ] }, - "website_url": { - "description": "The enterprise's website URL.", + "gravatar_id": { "type": [ "string", "null" ], - "format": "uri" + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "null" + ], + "properties": { "id": { - "description": "Unique identifier of the enterprise", + "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ - 42 + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" ] }, "node_id": { "type": "string", "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "MDExOkludGVncmF0aW9uMQ==" ] }, - "name": { - "description": "The name of the enterprise.", + "client_id": { "type": "string", "examples": [ - "Octo Business" + "\"Iv1.25b5d1e65ffc4022\"" ] }, - "slug": { - "description": "The slug url identifier for the enterprise.", + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "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", "type": "string", "examples": [ - "octo-business" + "Probot Owners" ] }, - "created_at": { + "description": { "type": [ "string", "null" ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", "format": "date-time", "examples": [ - "2019-01-26T19:01:12Z" + "2017-07-08T16:18:44-04:00" ] }, "updated_at": { - "type": [ - "string", - "null" - ], + "type": "string", "format": "date-time", "examples": [ - "2019-01-26T19:14:43Z" + "2017-07-08T16:18:44-04:00" ] }, - "avatar_url": { - "type": "string", - "format": "uri" + "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.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] } }, "required": [ "id", "node_id", + "owner", "name", - "slug", + "description", + "external_url", "html_url", "created_at", "updated_at", - "avatar_url" + "permissions", + "events" ] } ] }, - "name": { - "description": "The name of the GitHub app", + "author_association": { + "title": "author_association", "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" ], "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" + "OWNER" ] }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" + "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" ] }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" + "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" ] }, - "permissions": { - "description": "The set of permissions for the GitHub app", + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", "type": "object", "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" + "blocked_by": { + "type": "integer" }, - "metadata": { - "type": "string" + "blocking": { + "type": "integer" }, - "contents": { - "type": "string" + "total_blocked_by": { + "type": "integer" }, - "deployments": { - "type": "string" + "total_blocking": { + "type": "integer" } }, - "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.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" ] } }, "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", "id", "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", "created_at", - "updated_at", - "permissions", - "events" + "updated_at" ] } ] }, - "reactions": { - "title": "Reaction Rollup", + "label": { + "title": "Issue Event Label", + "description": "Issue Event Label", "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" + "name": { + "type": [ + "string", + "null" + ] }, - "rocket": { - "type": "integer" + "color": { + "type": [ + "string", + "null" + ] } }, "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" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/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" - } - }, - "patch": { - "summary": "Update an issue comment", - "description": "You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\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-comment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/comments#update-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": { - "body": { - "type": "string", - "description": "The contents of the comment." - } - }, - "required": [ - "body" - ] - }, - "examples": { - "default": { - "value": { - "body": "Me too" - } - } - } - } - } - }, - "responses": { - "200": { - "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", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/issues/comments/1" - ] - }, - "body": { - "description": "Contents of the issue comment", - "type": "string", - "examples": [ - "What version of Safari were you using when you observed this bug?" + "name", + "color" ] }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { + "assignee": { "anyOf": [ { "type": "null" @@ -351098,1176 +365796,182 @@ } ] }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "OWNER" - ] - }, - "performed_via_github_app": { + "assigner": { "anyOf": [ { "type": "null" }, { - "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", - "null" - ], + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, "id": { - "description": "Unique identifier of the GitHub app", "type": "integer", + "format": "int64", "examples": [ - 37 + 1 ] }, - "slug": { - "description": "The slug name of the GitHub app", + "node_id": { "type": "string", "examples": [ - "probot-owners" + "MDQ6VXNlcjE=" ] }, - "node_id": { + "avatar_url": { "type": "string", + "format": "uri", "examples": [ - "MDExOkludGVncmF0aW9uMQ==" + "https://github.com/images/error/octocat_happy.gif" ] }, - "client_id": { + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { "type": "string", + "format": "uri", "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" + "https://api.github.com/users/octocat" ] }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "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" - ] - } + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" ] }, - "name": { - "description": "The name of the GitHub app", + "followers_url": { "type": "string", + "format": "uri", "examples": [ - "Probot Owners" + "https://api.github.com/users/octocat/followers" ] }, - "description": { - "type": [ - "string", - "null" - ], + "following_url": { + "type": "string", "examples": [ - "The description of the app." + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "external_url": { + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { "type": "string", "format": "uri", "examples": [ - "https://example.com" + "https://api.github.com/users/octocat/subscriptions" ] }, - "html_url": { + "organizations_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/apps/super-ci" + "https://api.github.com/users/octocat/orgs" ] }, - "created_at": { + "repos_url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2017-07-08T16:18:44-04:00" + "https://api.github.com/users/octocat/repos" ] }, - "updated_at": { + "events_url": { "type": "string", - "format": "date-time", "examples": [ - "2017-07-08T16:18:44-04:00" + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "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" - } + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_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.", - "type": "array", - "items": { - "type": "string" - }, + "type": { + "type": "string", "examples": [ - "label", - "deployment" + "User" ] }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", "examples": [ - 5 + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", "id", "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] } ] }, - "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", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "examples": [ - "heart" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" - ] - }, - "user": { + "review_requester": { "anyOf": [ { "type": "null" @@ -352442,94 +366146,7 @@ } ] }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "examples": [ - "heart" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" - ] - }, - "user": { + "requested_reviewer": { "anyOf": [ { "type": "null" @@ -352671,1038 +366288,408 @@ "starred_at": { "type": "string", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "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", + "null" + ] + }, + "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", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "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", + "null" + ] + }, + "dismissal_commit_id": { + "type": [ + "string", + "null" + ] + } + }, + "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", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + }, + "lock_reason": { + "type": [ + "string", + "null" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" ] }, - "user_view_type": { + "client_id": { "type": "string", "examples": [ - "public" + "\"Iv1.25b5d1e65ffc4022\"" ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "examples": [ - "heart" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOklzc3VlRXZlbnQx" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/events/1" - ] - }, - "actor": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "event": { - "type": "string", - "examples": [ - "closed" - ] - }, - "commit_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "commit_url": { - "type": [ - "string", - "null" - ], - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] - }, - "issue": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/issues/1" - ] - }, - "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", - "type": "integer", - "examples": [ - 42 - ] - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ], - "examples": [ - "not_planned" - ] - }, - "title": { - "description": "Title of the issue", - "type": "string", - "examples": [ - "Widget creation fails in Safari on OS X 10.8" - ] - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ], - "examples": [ - "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?" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "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", - "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", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - }, - "examples": [ - "bug", - "registration" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "assignees": { - "type": [ - "array", - "null" - ], - "items": { + "owner": { + "oneOf": [ + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -353773,3891 +366760,3662 @@ "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/milestones/v1.0" - ] - }, - "labels_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDk6TWlsZXN0b25lMTAwMjYwNA==" - ] - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "examples": [ - 42 - ] - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open", - "examples": [ - "open" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string", - "examples": [ - "v1.0" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "Tracking milestone for version 1.0" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 4 - ] - }, - "closed_issues": { - "type": "integer", - "examples": [ - 8 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2013-02-12T13:22:01Z" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2012-10-09T23:39:01Z" - ] - } - }, - "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" - ] - } - ] - }, - "locked": { - "type": "boolean" - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "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", - "null" - ], - "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", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "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", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + ] }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } - } + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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": [ - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "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", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 - ] - } + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "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" + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } }, - "rocket": { - "type": "integer" - } + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "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" - } + "checks": { + "type": "string" }, - "required": [ - "total", - "completed", - "percent_completed" - ] + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" } }, - "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" - ] - } - ] + "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.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "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 }, - "label": { - "title": "Issue Event Label", - "description": "Issue Event Label", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] + "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/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", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/1" + ] + }, + "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", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate", + null + ], + "examples": [ + "not_planned" + ] + }, + "title": { + "description": "Title of the issue", + "type": "string", + "examples": [ + "Widget creation fails in Safari on OS X 10.8" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ], + "examples": [ + "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?" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - "color": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "name", - "color" - ] - }, - "assignee": { - "anyOf": [ + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "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", + "type": "array", + "items": { + "oneOf": [ { - "type": "null" + "type": "string" }, { - "title": "Simple User", - "description": "A GitHub user.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { "type": "integer", - "format": "int64", - "examples": [ - 1 - ] + "format": "int64" }, "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] + "type": "string" }, "url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "format": "uri" }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "assigner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { "name": { - "type": [ - "string", - "null" - ] + "type": "string" }, - "email": { + "description": { "type": [ "string", "null" ] }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { + "color": { "type": [ "string", "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" ] }, - "site_admin": { + "default": { "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + } } ] }, - "review_requester": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + "examples": [ + "bug", + "registration" + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "requested_reviewer": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + "email": { + "type": [ + "string", + "null" + ] }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "requested_team": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "assignees": { + "type": [ + "array", + "null" + ], + "items": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, "id": { - "type": "integer" + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] }, "node_id": { - "type": "string" - }, - "name": { - "type": "string" + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] }, - "slug": { - "type": "string" + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, - "description": { + "gravatar_id": { "type": [ "string", "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" ] }, - "privacy": { - "type": "string" + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] }, - "notification_setting": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] }, - "permission": { - "type": "string" + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] }, - "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" + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "url": { + "gists_url": { "type": "string", - "format": "uri" + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] }, - "html_url": { + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/orgs/rails/teams/core" + "https://api.github.com/users/octocat/subscriptions" ] }, - "members_url": { - "type": "string" + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] }, - "repositories_url": { + "repos_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] - } + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", "id", "node_id", - "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" ] + } + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string", + "examples": [ + "v1.0" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] + } + }, + "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" + ] + } + ] + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } }, - "dismissed_review": { - "title": "Issue Event Dismissed Review", - "type": "object", - "properties": { - "state": { - "type": "string" + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - "review_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" + ] + } + ] + }, + "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", + "null" + ], + "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", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "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", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } }, - "dismissal_message": { - "type": [ - "string", - "null" - ] + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - "dismissal_commit_id": { - "type": [ - "string", - "null" - ] - } + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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": [ - "state", - "review_id", - "dismissal_message" - ] - }, - "milestone": { - "title": "Issue Event Milestone", - "description": "Issue Event Milestone", - "type": "object", - "properties": { - "title": { - "type": "string" - } + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" }, - "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" - } + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] }, - "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": { + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { "type": "string" } }, - "required": [ - "from", - "to" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "OWNER" - ] - }, - "lock_reason": { - "type": [ - "string", - "null" - ] + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + "required": [ + "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": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } + "email": { + "type": [ + "string", + "null" + ] }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - "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", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "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", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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.", - "type": "array", - "items": { + "metadata": { "type": "string" }, - "examples": [ - "label", - "deployment" - ] + "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.", - "type": "integer", - "examples": [ - 5 - ] + "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.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "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", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "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=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "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" + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "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" + } } } } - }, - "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" @@ -357665,82 +370423,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", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "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": [ { @@ -357762,7 +370502,8 @@ } }, { - "name": "event_id", + "name": "issue_number", + "description": "The number that identifies the issue.", "in": "path", "required": true, "schema": { @@ -357770,37 +370511,249 @@ } } ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "integer" + } + ], + "description": "The title of the issue.", + "type": [ + "null", + "string", + "integer" + ] + }, + "body": { + "type": [ + "string", + "null" + ], + "description": "The contents of the issue." + }, + "assignee": { + "type": [ + "string", + "null" + ], + "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", + "null" + ], + "enum": [ + "completed", + "not_planned", + "duplicate", + "reopened", + null + ], + "description": "The reason for the state change. Ignored unless `state` is changed.", + "examples": [ + "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." + } + ], + "type": [ + "null", + "string", + "integer" + ] + }, + "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", + "null" + ] + }, + "color": { + "type": [ + "string", + "null" + ] + } + } + } + ] + } + }, + "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", + "null" + ], + "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.", + "examples": [ + "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", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri", "examples": [ - 1 + "https://api.github.com/repositories/42/issues/1" ] }, - "node_id": { + "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", + "type": "integer", "examples": [ - "MDEwOklzc3VlRXZlbnQx" + 42 ] }, - "url": { + "state": { + "description": "State of the issue; either 'open' or 'closed'", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/events/1" + "open" ] }, - "actor": { + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate", + null + ], + "examples": [ + "not_planned" + ] + }, + "title": { + "description": "Title of the issue", + "type": "string", + "examples": [ + "Widget creation fails in Safari on OS X 10.8" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ], + "examples": [ + "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?" + ] + }, + "user": { "anyOf": [ { "type": "null" @@ -357975,1474 +370928,488 @@ } ] }, - "event": { - "type": "string", - "examples": [ - "closed" - ] - }, - "commit_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "commit_url": { - "type": [ - "string", - "null" - ], - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", + "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", + "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", + "null" + ] + }, + "color": { + "type": [ + "string", + "null" + ] + }, + "default": { + "type": "boolean" + } + } + } + ] + }, "examples": [ - "2011-04-14T16:00:49Z" + "bug", + "registration" ] }, - "issue": { + "assignee": { "anyOf": [ { "type": "null" }, { - "title": "Issue", - "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, "id": { "type": "integer", - "format": "int64" + "format": "int64", + "examples": [ + 1 + ] }, "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/repositories/42/issues/1" + "MDQ6VXNlcjE=" ] }, - "repository_url": { + "avatar_url": { "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string" + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, - "comments_url": { - "type": "string", - "format": "uri" + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] }, - "events_url": { + "url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] }, "html_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "type": "integer", + "followers_url": { + "type": "string", + "format": "uri", "examples": [ - 42 + "https://api.github.com/users/octocat/followers" ] }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", + "following_url": { "type": "string", "examples": [ - "open" + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ], + "gists_url": { + "type": "string", "examples": [ - "not_planned" + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "title": { - "description": "Title of the issue", + "starred_url": { "type": "string", "examples": [ - "Widget creation fails in Safari on OS X 10.8" + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ], + "subscriptions_url": { + "type": "string", + "format": "uri", "examples": [ - "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?" + "https://api.github.com/users/octocat/subscriptions" ] }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" ] }, - "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", - "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", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - }, + "repos_url": { + "type": "string", + "format": "uri", "examples": [ - "bug", - "registration" + "https://api.github.com/users/octocat/repos" ] }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "assignees": { - "type": [ - "array", - "null" - ], - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/milestones/v1.0" - ] - }, - "labels_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDk6TWlsZXN0b25lMTAwMjYwNA==" - ] - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "examples": [ - 42 - ] - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open", - "examples": [ - "open" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string", - "examples": [ - "v1.0" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "Tracking milestone for version 1.0" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 4 - ] - }, - "closed_issues": { - "type": "integer", - "examples": [ - 8 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2013-02-12T13:22:01Z" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2012-10-09T23:39:01Z" - ] - } - }, - "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" - ] - } + "type": { + "type": "string", + "examples": [ + "User" ] }, - "locked": { + "site_admin": { "type": "boolean" }, - "active_lock_reason": { - "type": [ - "string", - "null" + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" ] }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "assignees": { + "type": [ + "array", + "null" + ], + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" ] }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { + "html_url": { "type": "string", - "format": "date-time" + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] }, - "updated_at": { + "labels_url": { "type": "string", - "format": "date-time" + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] }, - "draft": { - "type": "boolean" + "id": { + "type": "integer", + "examples": [ + 1002604 + ] }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 ] }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] }, - "timeline_url": { + "title": { + "description": "The title of the milestone.", "type": "string", - "format": "uri" + "examples": [ + "v1.0" + ] }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", + "description": { "type": [ - "object", + "string", "null" ], - "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", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "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": [ + "Tracking milestone for version 1.0" ] }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] + "creator": { + "anyOf": [ + { + "type": "null" }, - "owner": { + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -359609,1209 +371576,2656 @@ "type", "url" ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] + } + }, + "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" + ] + } + ] + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "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", + "null" + ], + "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", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "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", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" + "mit" ] }, - "svn_url": { + "name": { "type": "string", - "format": "uri", "examples": [ - "https://svn.github.com/octocat/Hello-World" + "MIT License" ] }, - "homepage": { + "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" + "https://api.github.com/licenses/mit" ] }, - "updated_at": { + "spdx_id": { "type": [ "string", "null" ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", "examples": [ - false + "MIT" ] }, - "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": { + "node_id": { "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", "examples": [ - true + "MDc6TGljZW5zZW1pdA==" ] }, - "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": { + "html_url": { "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } + "format": "uri" } }, "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", + "key", "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" + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 ] }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ { - "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", - "null" - ], + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, "id": { - "description": "Unique identifier of the GitHub app", "type": "integer", + "format": "int64", "examples": [ - 37 + 1 ] }, - "slug": { - "description": "The slug name of the GitHub app", + "node_id": { "type": "string", "examples": [ - "probot-owners" + "MDQ6VXNlcjE=" ] }, - "node_id": { + "avatar_url": { "type": "string", + "format": "uri", "examples": [ - "MDExOkludGVncmF0aW9uMQ==" + "https://github.com/images/error/octocat_happy.gif" ] }, - "client_id": { + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { "type": "string", + "format": "uri", "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" + "https://api.github.com/users/octocat" ] }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "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" - ] - } + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" ] }, - "name": { - "description": "The name of the GitHub app", + "followers_url": { "type": "string", + "format": "uri", "examples": [ - "Probot Owners" + "https://api.github.com/users/octocat/followers" ] }, - "description": { - "type": [ - "string", - "null" - ], + "following_url": { + "type": "string", "examples": [ - "The description of the app." + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "external_url": { + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { "type": "string", "format": "uri", "examples": [ - "https://example.com" + "https://api.github.com/users/octocat/subscriptions" ] }, - "html_url": { + "organizations_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/apps/super-ci" + "https://api.github.com/users/octocat/orgs" ] }, - "created_at": { + "repos_url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2017-07-08T16:18:44-04:00" + "https://api.github.com/users/octocat/repos" ] }, - "updated_at": { + "events_url": { "type": "string", - "format": "date-time", "examples": [ - "2017-07-08T16:18:44-04:00" + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "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" - } + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_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.", - "type": "array", - "items": { - "type": "string" - }, + "type": { + "type": "string", "examples": [ - "label", - "deployment" + "User" ] }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", "type": "integer", "examples": [ - 5 + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" ] + }, + "avatar_url": { + "type": "string", + "format": "uri" } }, "required": [ "id", "node_id", - "owner", "name", - "description", - "external_url", + "slug", "html_url", "created_at", "updated_at", - "permissions", - "events" + "avatar_url" ] } ] }, - "author_association": { - "title": "author_association", + "name": { + "description": "The name of the GitHub app", "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" ], "examples": [ - "OWNER" + "The description of the app." ] }, - "reactions": { - "title": "Reaction Rollup", + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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" - ] + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "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.", + "type": "array", + "items": { + "type": "string" }, - "required": [ - "total", - "completed", - "percent_completed" + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 ] } }, "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" ] } ] }, - "label": { - "title": "Issue Event Label", - "description": "Issue Event Label", + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] + "url": { + "type": "string", + "format": "uri" }, - "color": { - "type": [ - "string", - "null" - ] + "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": [ - "name", - "color" + "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=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/1" + ] + }, + "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", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate", + null + ], + "examples": [ + "not_planned" + ] + }, + "title": { + "description": "Title of the issue", + "type": "string", + "examples": [ + "Widget creation fails in Safari on OS X 10.8" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ], + "examples": [ + "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?" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "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", + "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", + "null" + ] + }, + "color": { + "type": [ + "string", + "null" + ] + }, + "default": { + "type": "boolean" + } + } + } + ] + }, + "examples": [ + "bug", + "registration" ] }, "assignee": { @@ -360875,296 +374289,692 @@ "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "assignees": { + "type": [ + "array", + "null" + ], + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "https://github.com/octocat/Hello-World/milestones/v1.0" ] }, - "organizations_url": { + "labels_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" ] }, - "repos_url": { - "type": "string", - "format": "uri", + "id": { + "type": "integer", "examples": [ - "https://api.github.com/users/octocat/repos" + 1002604 ] }, - "events_url": { + "node_id": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "MDk6TWlsZXN0b25lMTAwMjYwNA==" ] }, - "received_events_url": { - "type": "string", - "format": "uri", + "number": { + "description": "The number of the milestone.", + "type": "integer", "examples": [ - "https://api.github.com/users/octocat/received_events" + 42 ] }, - "type": { + "state": { + "description": "The state of the milestone.", "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", "examples": [ - "User" + "open" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { + "title": { + "description": "The title of the milestone.", "type": "string", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "v1.0" ] }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "assigner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { + "description": { "type": [ "string", "null" + ], + "examples": [ + "Tracking milestone for version 1.0" ] }, - "email": { - "type": [ - "string", - "null" + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } ] }, - "login": { - "type": "string", + "open_issues": { + "type": "integer", "examples": [ - "octocat" + 4 ] }, - "id": { + "closed_issues": { "type": "integer", - "format": "int64", "examples": [ - 1 + 8 ] }, - "node_id": { + "created_at": { "type": "string", + "format": "date-time", "examples": [ - "MDQ6VXNlcjE=" + "2011-04-10T20:09:31Z" ] }, - "avatar_url": { + "updated_at": { "type": "string", - "format": "uri", + "format": "date-time", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "2014-03-03T18:58:10Z" ] }, - "gravatar_id": { + "closed_at": { "type": [ "string", "null" ], + "format": "date-time", "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" + "2013-02-12T13:22:01Z" ] }, - "user_view_type": { - "type": "string", + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", "examples": [ - "public" + "2012-10-09T23:39:01Z" ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" ] } ] }, - "review_requester": { + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { "anyOf": [ { "type": "null" @@ -361339,12 +375149,206 @@ } ] }, - "requested_reviewer": { - "anyOf": [ - { - "type": "null" + "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", + "null" + ], + "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", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "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", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -361511,334 +375515,664 @@ "type", "url" ] - } - ] - }, - "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" + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" }, - "slug": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] }, "description": { "type": [ "string", "null" + ], + "examples": [ + "This your first repo!" ] }, - "privacy": { - "type": "string" + "fork": { + "type": "boolean" }, - "notification_setting": { - "type": "string" + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] }, - "permission": { - "type": "string" + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] }, - "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" + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, - "url": { + "blobs_url": { "type": "string", - "format": "uri" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] }, - "html_url": { + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/orgs/rails/teams/core" + "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, - "members_url": { - "type": "string" + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] }, - "repositories_url": { + "downloads_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] - } + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" ] - } - }, - "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": { + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", "type": "string" }, - "review_id": { - "type": "integer" + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] }, - "dismissal_message": { + "created_at": { "type": [ "string", "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" ] }, - "dismissal_commit_id": { + "updated_at": { "type": [ "string", "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" ] - } - }, - "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", + "examples": [ + 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", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { "type": "string", - "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", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { "type": "integer" }, - "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", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } } }, "required": [ - "from", - "to" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "OWNER" - ] - }, - "lock_reason": { - "type": [ - "string", - "null" + "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": { @@ -362248,26 +376582,159 @@ ] } ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "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=", @@ -362287,24 +376754,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=", @@ -362323,19 +376805,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=", @@ -362355,198 +376837,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" } } } @@ -362558,21 +376889,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": [ { @@ -362603,6 +376932,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", @@ -364784,86 +379141,2122 @@ "lexical_search_ok": { "type": "boolean" }, - "lexical_commit_sha": { - "type": "string" + "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": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "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", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "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=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "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" + } + } + } + } + } + } + }, + "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" + } + }, + { + "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": { + "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": "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", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/comments/1" + ] + }, + "body": { + "description": "Contents of the issue comment", + "type": "string", + "examples": [ + "What version of Safari were you using when you observed this bug?" + ] + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "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", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "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", + "content": { + "application/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", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/comments/1" + ] + }, + "body": { + "description": "Contents of the issue comment", + "type": "string", + "examples": [ + "What version of Safari were you using when you observed this bug?" + ] + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] } - }, - "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" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" ] }, "performed_via_github_app": { @@ -365274,24 +381667,6 @@ } ] }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "OWNER" - ] - }, "reactions": { "title": "Reaction Rollup", "type": "object", @@ -365340,48 +381715,16 @@ "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", + "html_url", + "issue_url", "author_association", + "user", + "url", "created_at", "updated_at" ] @@ -365390,17 +381733,10 @@ "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.", + "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, @@ -365421,138 +381757,26 @@ "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" + "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" + } + } } }, - "301": { - "description": "Moved permanently", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -365577,8 +381801,8 @@ } } }, - "404": { - "description": "Resource not found", + "410": { + "description": "Gone", "content": { "application/json": { "schema": { @@ -365603,8 +381827,83 @@ } } }, - "410": { - "description": "Gone", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -365628,28 +381927,28 @@ } } } - }, - "304": { - "description": "Not modified" } }, "x-github": { + "triggersNotification": true, "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`.", + } + }, + "/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/update", + "operationId": "issues/list-dependencies-blocked-by", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/issues#update-an-issue" + "url": "https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by" }, "parameters": [ { @@ -365678,1595 +381977,525 @@ "schema": { "type": "integer" } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "title": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ], - "description": "The title of the issue.", - "type": [ - "null", - "string", - "integer" - ] - }, - "body": { - "type": [ - "string", - "null" - ], - "description": "The contents of the issue." - }, - "assignee": { - "type": [ - "string", - "null" - ], - "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", - "null" - ], - "enum": [ - "completed", - "not_planned", - "duplicate", - "reopened", - null - ], - "description": "The reason for the state change. Ignored unless `state` is changed.", - "examples": [ - "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." - } - ], - "type": [ - "null", - "string", - "integer" - ] - }, - "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", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - } - } - } - ] - } - }, - "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", - "null" - ], - "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.", - "examples": [ - "Epic" - ] - } - } - }, - "examples": { - "default": { - "value": { - "title": "Found a bug", - "body": "I'm having a problem with this.", - "assignees": [ - "octocat" - ], - "milestone": 1, - "state": "open", - "labels": [ - "bug" - ] - } - } - } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 } } - }, + ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "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", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/issues/1" - ] - }, - "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", - "type": "integer", - "examples": [ - 42 - ] - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ], - "examples": [ - "not_planned" - ] - }, - "title": { - "description": "Title of the issue", - "type": "string", - "examples": [ - "Widget creation fails in Safari on OS X 10.8" - ] - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ], - "examples": [ - "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?" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "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", - "type": "array", - "items": { - "oneOf": [ + "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", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/1" + ] + }, + "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", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate", + null + ], + "examples": [ + "not_planned" + ] + }, + "title": { + "description": "Title of the issue", + "type": "string", + "examples": [ + "Widget creation fails in Safari on OS X 10.8" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ], + "examples": [ + "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?" + ] + }, + "user": { + "anyOf": [ { - "type": "string" + "type": "null" }, { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, "id": { "type": "integer", - "format": "int64" + "format": "int64", + "examples": [ + 1 + ] }, "node_id": { - "type": "string" - }, - "url": { "type": "string", - "format": "uri" + "examples": [ + "MDQ6VXNlcjE=" + ] }, - "name": { - "type": "string" + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, - "description": { + "gravatar_id": { "type": [ "string", "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" ] }, - "color": { - "type": [ - "string", - "null" + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" ] }, - "default": { - "type": "boolean" - } - } - } - ] - }, - "examples": [ - "bug", - "registration" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "assignees": { - "type": [ - "array", - "null" - ], - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/milestones/v1.0" - ] - }, - "labels_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDk6TWlsZXN0b25lMTAwMjYwNA==" - ] - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "examples": [ - 42 - ] - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open", - "examples": [ - "open" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string", - "examples": [ - "v1.0" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "Tracking milestone for version 1.0" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 4 - ] - }, - "closed_issues": { - "type": "integer", - "examples": [ - 8 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2013-02-12T13:22:01Z" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2012-10-09T23:39:01Z" - ] - } - }, - "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" - ] - } - ] - }, - "locked": { - "type": "boolean" - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "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", - "null" - ], - "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", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "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": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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", - "name", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ + "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", + "type": "array", + "items": { + "oneOf": [ { - "type": "null" + "type": "string" }, { - "title": "License Simple", - "description": "License Simple", "type": "object", "properties": { - "key": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { "type": "string", - "examples": [ - "mit" - ] + "format": "uri" }, "name": { - "type": "string", - "examples": [ - "MIT License" - ] + "type": "string" }, - "url": { + "description": { "type": [ "string", "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" ] }, - "spdx_id": { + "color": { "type": [ "string", "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" ] }, - "html_url": { - "type": "string", - "format": "uri" + "default": { + "type": "boolean" } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] + } } ] }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } + "examples": [ + "bug", + "registration" + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "assignees": { + "type": [ + "array", + "null" + ], + "items": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -367433,1254 +382662,2168 @@ "type", "url" ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" + } + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string", + "examples": [ + "v1.0" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] + } + }, + "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" + ] + } + ] + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" } }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "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", + "null" + ], + "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", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "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", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } }, - "lexical_commit_sha": { + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { "type": "string" } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } } - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "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": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "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", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "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", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] }, - "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.", + "type": "integer", + "examples": [ + 5 + ] } }, - "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.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 - ] - } + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "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" + "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" + } }, - "rocket": { - "type": "integer" - } + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] }, - "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" + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } }, - "percent_completed": { - "type": "integer" - } + "required": [ + "total", + "completed", + "percent_completed" + ] }, - "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" - ] + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_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", + "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=", @@ -368699,19 +384842,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=", @@ -368731,171 +384874,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", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "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" } } } @@ -368983,21 +385065,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": [ { @@ -369029,28 +385109,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 } } } @@ -371814,6 +387891,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": [ @@ -372003,26 +388104,216 @@ } } } + }, + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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/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": [ { @@ -372051,36 +388342,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", @@ -374645,605 +390917,1746 @@ } ] }, - "name": { - "description": "The name of the GitHub app", + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "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=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "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" + } + } + } + } + } + }, + "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "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" + } + } + } + } + } + }, + "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": { + "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": [ + { + "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", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/1" + ] + }, + "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", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate", + null + ], + "examples": [ + "not_planned" + ] + }, + "title": { + "description": "Title of the issue", + "type": "string", + "examples": [ + "Widget creation fails in Safari on OS X 10.8" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ], + "examples": [ + "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?" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "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", + "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", + "null" + ] + }, + "color": { + "type": [ + "string", + "null" + ] + }, + "default": { + "type": "boolean" + } + } + } + ] + }, + "examples": [ + "bug", + "registration" + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "assignees": { + "type": [ + "array", + "null" + ], + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { "type": "string", "examples": [ - "Probot Owners" + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "description": { - "type": [ - "string", - "null" - ], + "starred_url": { + "type": "string", "examples": [ - "The description of the app." + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "external_url": { + "subscriptions_url": { "type": "string", "format": "uri", "examples": [ - "https://example.com" + "https://api.github.com/users/octocat/subscriptions" ] }, - "html_url": { + "organizations_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/apps/super-ci" + "https://api.github.com/users/octocat/orgs" ] }, - "created_at": { + "repos_url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2017-07-08T16:18:44-04:00" + "https://api.github.com/users/octocat/repos" ] }, - "updated_at": { + "events_url": { "type": "string", - "format": "date-time", "examples": [ - "2017-07-08T16:18:44-04:00" + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "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" - } + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_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.", - "type": "array", - "items": { - "type": "string" - }, + "type": { + "type": "string", "examples": [ - "label", - "deployment" + "User" ] }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", "examples": [ - 5 + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", "id", "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] } - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "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" - } + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string", + "examples": [ + "v1.0" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] + } + }, + "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" + ] + } + ] }, - "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" - ] - }, - "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 + "locked": { + "type": "boolean" }, - "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 + "active_lock_reason": { + "type": [ + "string", + "null" + ] }, - "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" + "comments": { + "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" - }, - "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" - } - } - } - } - } - } - }, - "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" - } - }, - { - "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": { - "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": "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", - "type": "integer", - "format": "int64", - "examples": [ - 42 + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" ] }, - "node_id": { - "type": "string" + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - "url": { - "description": "URL for the issue comment", + "created_at": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/issues/comments/1" - ] + "format": "date-time" }, - "body": { - "description": "Contents of the issue comment", + "updated_at": { "type": "string", - "examples": [ - "What version of Safari were you using when you observed this bug?" - ] - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" + "format": "date-time" }, - "html_url": { - "type": "string", - "format": "uri" + "draft": { + "type": "boolean" }, - "user": { + "closed_by": { "anyOf": [ { "type": "null" @@ -375418,40 +392831,1030 @@ } ] }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] + "body_html": { + "type": "string" }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] + "body_text": { + "type": "string" }, - "issue_url": { + "timeline_url": { "type": "string", "format": "uri" }, - "author_association": { - "title": "author_association", - "type": "string", - "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", + "null" ], - "examples": [ - "OWNER" + "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", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "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", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" ] }, "performed_via_github_app": { @@ -375862,6 +394265,24 @@ } ] }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + }, "reactions": { "title": "Reaction Rollup", "type": "object", @@ -375910,16 +394331,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" ] @@ -375930,10 +394407,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, @@ -375954,10 +394438,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" } ] } @@ -375973,34 +394577,8 @@ } } }, - "404": { - "description": "Resource not found", - "content": { - "application/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", + "301": { + "description": "Moved permanently", "content": { "application/json": { "schema": { @@ -376024,856 +394602,9 @@ } } } - } - }, - "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", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/issues/comments/1" - ] - }, - "body": { - "description": "Contents of the issue comment", - "type": "string", - "examples": [ - "What version of Safari were you using when you observed this bug?" - ] - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "OWNER" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "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", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 - ] - } - }, - "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", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -376923,115 +394654,13 @@ } } } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/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" } } }, @@ -394218,6 +411847,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": [ @@ -397339,6 +414992,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": [ @@ -400428,6 +418105,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": [ @@ -403622,6 +421323,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": [ @@ -417222,6 +434947,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": [ @@ -533644,6 +551393,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" }, @@ -586118,6 +603891,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": [ @@ -621404,6 +639201,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": [ @@ -625207,6 +643028,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": [ @@ -629012,6 +646857,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": [ @@ -640192,6 +658061,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": [ @@ -643997,6 +661890,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": [ @@ -838328,6 +856245,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", @@ -842610,6 +860551,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", @@ -846916,6 +864881,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", @@ -852111,6 +870100,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": [ @@ -854893,6 +872906,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": [ @@ -860518,6 +878555,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": [ @@ -863300,6 +881361,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": [ @@ -868925,6 +887010,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": [ @@ -872656,6 +890765,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": [ @@ -877332,6 +895465,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": [ @@ -881063,6 +899220,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": [ @@ -884308,6 +902489,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", @@ -887625,6 +905830,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", @@ -891150,6 +909379,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", @@ -894479,6 +912732,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", @@ -897989,6 +916266,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", @@ -901342,6 +919643,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", @@ -904723,6 +923048,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", @@ -908028,6 +926377,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", @@ -911395,6 +929768,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", @@ -913455,6 +931852,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", @@ -916760,6 +935181,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", @@ -920092,6 +938537,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", @@ -923263,6 +941732,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", @@ -925339,6 +943832,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", @@ -928651,6 +947168,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", @@ -932132,6 +950673,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", @@ -935444,6 +954009,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", @@ -938823,6 +957412,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", @@ -942105,6 +960718,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", @@ -945416,6 +964053,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", @@ -1051112,6 +1069773,266 @@ ] } ] + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "latest_status_update": { + "anyOf": [ + { + "type": "null" + }, + { + "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": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "status": { + "type": [ + "string", + "null" + ], + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + "start_date": { + "type": "string", + "format": "date", + "examples": [ + "2022-04-28" + ] + }, + "target_date": { + "type": "string", + "format": "date", + "examples": [ + "2022-04-28" + ] + }, + "body": { + "description": "Body of the status update", + "type": [ + "string", + "null" + ], + "examples": [ + "The project is off to a great start!" + ] + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ] + } + ] + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" } }, "required": [ @@ -1052106,6 +1071027,266 @@ ] } ] + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "latest_status_update": { + "anyOf": [ + { + "type": "null" + }, + { + "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": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "status": { + "type": [ + "string", + "null" + ], + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + "start_date": { + "type": "string", + "format": "date", + "examples": [ + "2022-04-28" + ] + }, + "target_date": { + "type": "string", + "format": "date", + "examples": [ + "2022-04-28" + ] + }, + "body": { + "description": "Body of the status update", + "type": [ + "string", + "null" + ], + "examples": [ + "The project is off to a great start!" + ] + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ] + } + ] + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" } }, "required": [ @@ -1053100,6 +1072281,266 @@ ] } ] + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "latest_status_update": { + "anyOf": [ + { + "type": "null" + }, + { + "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": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "status": { + "type": [ + "string", + "null" + ], + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + "start_date": { + "type": "string", + "format": "date", + "examples": [ + "2022-04-28" + ] + }, + "target_date": { + "type": "string", + "format": "date", + "examples": [ + "2022-04-28" + ] + }, + "body": { + "description": "Body of the status update", + "type": [ + "string", + "null" + ], + "examples": [ + "The project is off to a great start!" + ] + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ] + } + ] + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" } }, "required": [ @@ -1054155,6 +1073596,266 @@ ] } ] + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "latest_status_update": { + "anyOf": [ + { + "type": "null" + }, + { + "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": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "status": { + "type": [ + "string", + "null" + ], + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + "start_date": { + "type": "string", + "format": "date", + "examples": [ + "2022-04-28" + ] + }, + "target_date": { + "type": "string", + "format": "date", + "examples": [ + "2022-04-28" + ] + }, + "body": { + "description": "Body of the status update", + "type": [ + "string", + "null" + ], + "examples": [ + "The project is off to a great start!" + ] + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ] + } + ] + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" } }, "required": [ @@ -1059842,6 +1079543,266 @@ ] } ] + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "latest_status_update": { + "anyOf": [ + { + "type": "null" + }, + { + "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": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "status": { + "type": [ + "string", + "null" + ], + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + "start_date": { + "type": "string", + "format": "date", + "examples": [ + "2022-04-28" + ] + }, + "target_date": { + "type": "string", + "format": "date", + "examples": [ + "2022-04-28" + ] + }, + "body": { + "description": "Body of the status update", + "type": [ + "string", + "null" + ], + "examples": [ + "The project is off to a great start!" + ] + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ] + } + ] + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" } }, "required": [ @@ -1358176,6 +1378137,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": [ @@ -1361907,6 +1381892,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": [ @@ -1366580,6 +1386589,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": [ @@ -1370311,6 +1390344,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": [ @@ -1374984,6 +1395041,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": [ @@ -1378715,6 +1398796,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": [ @@ -1383388,6 +1403493,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": [ @@ -1387119,6 +1407248,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-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index f90ef74520..267186ebf3 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -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: @@ -901,7 +903,7 @@ paths: - subscriptions_url - type - url - type: &267 + type: &272 type: string description: The type of credit the user is receiving. enum: @@ -1034,7 +1036,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &95 + schema: &98 title: Validation Error Simple description: Validation Error Simple type: object @@ -1067,7 +1069,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &580 + - &590 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1652,7 +1654,7 @@ paths: schema: type: integer default: 30 - - &164 + - &167 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 @@ -1668,7 +1670,7 @@ paths: application/json: schema: type: array - items: &165 + items: &168 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1764,7 +1766,7 @@ paths: - installation_id - repository_id examples: - default: &166 + default: &169 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1827,7 +1829,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &94 + schema: &97 title: Validation Error description: Validation Error type: object @@ -1899,7 +1901,7 @@ paths: description: Response content: application/json: - schema: &167 + schema: &170 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -2034,7 +2036,7 @@ paths: - request - response examples: - default: &168 + default: &171 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -5382,7 +5384,7 @@ paths: responses: '202': *37 '422': *7 - '500': &91 + '500': &94 description: Internal Error content: application/json: @@ -7713,7 +7715,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: &138 + code_scanning_options: &141 type: - object - 'null' @@ -7911,7 +7913,7 @@ paths: description: Response content: application/json: - schema: &140 + schema: &143 type: array description: A list of default code security configurations items: @@ -7927,7 +7929,7 @@ paths: default configuration: *41 examples: - default: &141 + default: &144 value: - default_for_new_repos: public configuration: @@ -8258,7 +8260,7 @@ paths: - *40 - *43 responses: - '204': &142 + '204': &145 description: A header with no content is returned. '400': *14 '403': *27 @@ -8385,7 +8387,7 @@ paths: default: value: default_for_new_repos: all - configuration: &139 + configuration: &142 value: id: 1325 target_type: organization @@ -8470,7 +8472,7 @@ paths: application/json: schema: type: array - items: &143 + items: &146 type: object description: Repositories associated with a code security configuration and attachment status @@ -8815,7 +8817,7 @@ paths: summary: Example of code security configuration repositories value: - status: attached - repository: &144 + repository: &147 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -8909,7 +8911,7 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *40 - - &148 + - &151 name: state in: query description: |- @@ -8918,7 +8920,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &149 + - &152 name: severity in: query description: |- @@ -8927,7 +8929,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &150 + - &153 name: ecosystem in: query description: |- @@ -8936,14 +8938,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &151 + - &154 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 - - &152 + - &155 name: epss_percentage in: query description: |- @@ -8955,7 +8957,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 - - &153 + - &156 name: has in: query description: |- @@ -8969,7 +8971,7 @@ paths: type: string enum: - patch - - &154 + - &157 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -8979,7 +8981,7 @@ paths: enum: - development - runtime - - &155 + - &158 name: sort in: query description: |- @@ -8997,7 +8999,7 @@ paths: - *46 - *38 - *39 - - &156 + - &159 name: first description: |- **Deprecated**. The number of results per page (max 100), starting from the first matching result. @@ -9010,7 +9012,7 @@ paths: minimum: 1 maximum: 100 default: 30 - - &157 + - &160 name: last description: |- **Deprecated**. The number of results per page (max 100), starting from the last matching result. @@ -9030,7 +9032,7 @@ paths: application/json: schema: type: array - items: &158 + items: &161 type: object description: A Dependabot alert. properties: @@ -9100,7 +9102,7 @@ paths: - direct - transitive - - security_advisory: &433 + security_advisory: &443 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -9329,7 +9331,7 @@ paths: 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissed_at: &134 + dismissed_at: &137 type: - string - 'null' @@ -9360,7 +9362,7 @@ paths: description: An optional comment associated with the alert's dismissal. maxLength: 280 - fixed_at: &133 + fixed_at: &136 type: - string - 'null' @@ -9368,7 +9370,7 @@ paths: and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - auto_dismissed_at: &434 + auto_dismissed_at: &444 type: - string - 'null' @@ -9395,7 +9397,7 @@ paths: - repository additionalProperties: false examples: - default: &159 + default: &162 value: - number: 2 state: dismissed @@ -9742,7 +9744,7 @@ paths: url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise parameters: - *40 - - &257 + - &260 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -9753,7 +9755,7 @@ paths: enum: - open - resolved - - &258 + - &261 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -9763,7 +9765,7 @@ paths: required: false schema: type: string - - &259 + - &262 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -9772,7 +9774,7 @@ paths: required: false schema: type: string - - &260 + - &263 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. @@ -9788,7 +9790,7 @@ paths: - *17 - *38 - *39 - - &261 + - &264 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -9797,7 +9799,7 @@ paths: required: false schema: type: string - - &262 + - &265 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -9806,7 +9808,7 @@ paths: schema: type: boolean default: false - - &263 + - &266 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -9815,7 +9817,7 @@ paths: schema: type: boolean default: false - - &264 + - &267 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -9831,7 +9833,7 @@ paths: application/json: schema: type: array - items: &265 + items: &268 type: object properties: number: *52 @@ -9847,14 +9849,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &558 + state: &568 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: &559 + resolution: &569 type: - string - 'null' @@ -9961,14 +9963,14 @@ paths: first_location_detected: anyOf: - type: 'null' - - &560 + - &570 description: 'Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. ' oneOf: - - &562 + - &572 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -10025,7 +10027,7 @@ paths: - blob_url - commit_sha - commit_url - - &563 + - &573 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. @@ -10086,7 +10088,7 @@ paths: - page_url - commit_sha - commit_url - - &564 + - &574 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -10101,7 +10103,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_title_url - - &565 + - &575 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -10116,7 +10118,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_body_url - - &566 + - &576 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -10131,7 +10133,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - issue_comment_url - - &567 + - &577 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -10146,7 +10148,7 @@ paths: - https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &568 + - &578 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -10161,7 +10163,7 @@ paths: - https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &569 + - &579 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -10176,7 +10178,7 @@ paths: - https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &570 + - &580 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. @@ -10191,7 +10193,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_title_url - - &571 + - &581 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. @@ -10206,7 +10208,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_body_url - - &572 + - &582 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. @@ -10221,7 +10223,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - pull_request_comment_url - - &573 + - &583 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. @@ -10236,7 +10238,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 required: - pull_request_review_url - - &574 + - &584 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 @@ -10257,7 +10259,7 @@ paths: description: A boolean value representing whether or not the token in the alert was detected in more than one location. examples: - default: &266 + default: &269 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -10727,7 +10729,7 @@ paths: milestone: anyOf: - type: 'null' - - &421 + - &431 title: Milestone description: A collection of related issues and pull requests. @@ -10899,7 +10901,7 @@ paths: timeline_url: type: string format: uri - type: &186 + type: &189 title: Issue Type description: The type of issue. type: @@ -11008,7 +11010,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &592 + sub_issues_summary: &602 title: Sub-issues Summary type: object properties: @@ -11022,6 +11024,23 @@ paths: - total - completed - percent_completed + issue_dependencies_summary: &603 + title: Issue Dependencies Summary + type: object + properties: + blocked_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 @@ -11044,7 +11063,7 @@ paths: - author_association - created_at - updated_at - comment: &480 + comment: &490 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -11619,7 +11638,7 @@ paths: url: type: string format: uri - user: &604 + user: &615 title: Public User description: Public User type: object @@ -13514,7 +13533,7 @@ paths: - closed - all default: open - - &189 + - &192 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -13565,7 +13584,7 @@ paths: type: array items: *74 examples: - default: &190 + default: &193 value: - id: 1 node_id: MDU6SXNzdWUx @@ -14977,14 +14996,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &289 + - &294 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &290 + - &295 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -15055,7 +15074,7 @@ paths: '404': *6 '403': *27 '304': *35 - '301': &301 + '301': &306 description: Moved permanently content: application/json: @@ -15077,7 +15096,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &509 + - &519 name: all description: If `true`, show notifications marked as read. in: query @@ -15085,7 +15104,7 @@ paths: schema: type: boolean default: false - - &510 + - &520 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -15095,7 +15114,7 @@ paths: type: boolean default: false - *64 - - &511 + - &521 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: @@ -15127,7 +15146,7 @@ paths: properties: id: type: string - repository: &116 + repository: &119 title: Minimal Repository description: Minimal Repository type: object @@ -15466,7 +15485,7 @@ paths: type: boolean examples: - false - security_and_analysis: &227 + security_and_analysis: &230 type: - object - 'null' @@ -15631,7 +15650,7 @@ paths: - url - subscription_url examples: - default: &512 + default: &522 value: - id: '1' repository: @@ -16180,7 +16199,7 @@ paths: application/json: schema: type: array - items: &146 + items: &149 title: Organization Simple description: A GitHub organization. type: object @@ -16252,7 +16271,7 @@ paths: - avatar_url - description examples: - default: &621 + default: &631 value: - login: github id: 1 @@ -16277,6 +16296,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: + - &90 + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: &321 + type: object + properties: + days: + type: integer + description: The number of days artifacts and logs are retained + maximum_allowed_days: + type: integer + description: The maximum number of days that can be configured + required: + - days + - maximum_allowed_days + examples: + response: + summary: Example response + value: + days: 90 + maximum_allowed_days: 365 + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set artifact and log retention settings for an organization + description: |- + Sets artifact and log retention settings for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/set-artifact-and-log-retention-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization + parameters: + - *90 + requestBody: + required: true + content: + application/json: + schema: &322 + type: object + properties: + days: + type: integer + description: The number of days to retain artifacts and logs + required: + - days + examples: + application/json: + value: + days: 100 + responses: + '204': + description: No content + '403': *27 + '404': *6 + '409': *45 + '422': *15 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/organizations/{org}/actions/permissions/fork-pr-contributor-approval": + get: + summary: Get fork PR contributor approval permissions for an organization + description: |- + Gets the fork PR contributor approval policy for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/get-fork-pr-contributor-approval-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization + parameters: + - *90 + responses: + '200': + description: Response + content: + application/json: + schema: &91 + type: object + properties: + approval_policy: + type: string + enum: + - first_time_contributors_new_to_github + - first_time_contributors + - all_external_contributors + description: The policy that controls when fork PR workflows require + approval from a maintainer. + required: + - approval_policy + examples: + default: &323 + value: + approval_policy: first_time_contributors + '404': *6 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set fork PR contributor approval permissions for an organization + description: |- + Sets the fork PR contributor approval policy for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/set-fork-pr-contributor-approval-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization + parameters: + - *90 + responses: + '204': + description: Response + '404': *6 + '422': *15 + requestBody: + required: true + content: + application/json: + schema: *91 + examples: + default: + summary: Set approval policy to first time contributors + value: + approval_policy: first_time_contributors + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/organizations/{org}/actions/permissions/fork-pr-workflows-private-repos": + get: + summary: Get private repo fork PR workflow settings for an organization + description: Gets the settings for whether workflows from fork pull requests + can run on private repositories in an organization. + operationId: actions/get-private-repo-fork-pr-workflows-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization + parameters: + - *90 + responses: + '200': + description: Response + content: + application/json: + schema: &324 + type: object + required: + - run_workflows_from_fork_pull_requests + - send_write_tokens_to_workflows + - send_secrets_and_variables + - require_approval_for_fork_pr_workflows + properties: + run_workflows_from_fork_pull_requests: + type: boolean + description: Whether workflows triggered by pull requests from + forks are allowed to run on private repositories. + send_write_tokens_to_workflows: + type: boolean + description: Whether GitHub Actions can create pull requests or + submit approving pull request reviews from a workflow triggered + by a fork pull request. + send_secrets_and_variables: + type: boolean + description: Whether to make secrets and variables available to + workflows triggered by pull requests from forks. + require_approval_for_fork_pr_workflows: + type: boolean + description: Whether workflows triggered by pull requests from + forks require approval from a repository administrator to run. + examples: + default: &92 + value: + run_workflows_from_fork_pull_requests: true + send_write_tokens_to_workflows: false + send_secrets_and_variables: false + require_approval_for_fork_pr_workflows: true + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set private repo fork PR workflow settings for an organization + description: Sets the settings for whether workflows from fork pull requests + can run on private repositories in an organization. + operationId: actions/set-private-repo-fork-pr-workflows-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization + parameters: + - *90 + requestBody: + required: true + content: + application/json: + schema: &325 + type: object + required: + - run_workflows_from_fork_pull_requests + properties: + run_workflows_from_fork_pull_requests: + type: boolean + description: Whether workflows triggered by pull requests from forks + are allowed to run on private repositories. + send_write_tokens_to_workflows: + type: boolean + description: Whether GitHub Actions can create pull requests or + submit approving pull request reviews from a workflow triggered + by a fork pull request. + send_secrets_and_variables: + type: boolean + description: Whether to make secrets and variables available to + workflows triggered by pull requests from forks. + require_approval_for_fork_pr_workflows: + type: boolean + description: Whether workflows triggered by pull requests from forks + require approval from a repository administrator to run. + examples: + default: *92 + responses: + '204': + description: Empty response for successful settings update + '403': + description: Forbidden - Fork PR workflow settings for private repositories + are managed by the enterprise owner + content: + application/json: + schema: *3 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/organizations/{org}/actions/permissions/self-hosted-runners": + get: + summary: Get self-hosted runners settings for an organization + description: |- + Gets the settings for self-hosted runners for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/get-self-hosted-runners-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization + parameters: + - *90 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - enabled_repositories + properties: + enabled_repositories: + type: string + description: The policy that controls whether self-hosted runners + can be used by repositories in the organization + enum: + - all + - selected + - none + selected_repositories_url: + type: string + description: The URL to the endpoint for managing selected repositories + for self-hosted runners in the organization + examples: + response: + summary: Example response + value: + enabled_repositories: selected + selected_repositories_url: http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set self-hosted runners settings for an organization + description: |- + Sets the settings for self-hosted runners for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/set-self-hosted-runners-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization + parameters: + - *90 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - enabled_repositories + properties: + enabled_repositories: + type: string + description: The policy that controls whether self-hosted runners + can be used in the organization + enum: + - all + - selected + - none + examples: + application/json: + value: + enabled_repositories: all + responses: + '204': + description: No content + '403': *27 + '404': *6 + '409': *45 + '422': *15 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/organizations/{org}/actions/permissions/self-hosted-runners/repositories": + get: + summary: List repositories allowed to use self-hosted runners in an organization + description: |- + Lists repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/list-selected-repositories-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - *90 + - *17 + - *19 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + total_count: + type: integer + repositories: + type: array + items: *59 + examples: + default: &109 + value: + total_count: 1 + repositories: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set repositories allowed to use self-hosted runners in an organization + description: |- + Sets repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/set-selected-repositories-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - *90 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - selected_repository_ids + properties: + selected_repository_ids: + type: array + items: + type: integer + description: IDs of repositories that can use repository-level self-hosted + runners + examples: + application/json: + value: + selected_repository_ids: + - 1 + - 2 + - 3 + responses: + '204': + description: No content + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/organizations/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}": + put: + summary: Add a repository to the list of repositories allowed to use self-hosted + runners in an organization + description: |- + Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/enable-selected-repository-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - *90 + - &93 + name: repository_id + description: The unique identifier of the repository. + in: path + required: true + schema: + type: integer + responses: + '204': + description: No content + '403': *27 + '404': *6 + '409': *45 + '422': *15 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + delete: + summary: Remove a repository from the list of repositories allowed to use self-hosted + runners in an organization + description: |- + Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/disable-selected-repository-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - *90 + - *93 + responses: + '204': + description: No content + '403': *27 + '404': *6 + '409': *45 + '422': *15 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions "/organizations/{org}/dependabot/repository-access": get: summary: Lists the repositories Dependabot can access in an organization @@ -16292,13 +16948,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: - - &90 - name: org - description: The organization name. The name is not case sensitive. - in: path - required: true - schema: - type: string + - *90 - name: page in: query description: The page number of results to fetch. @@ -16564,7 +17214,7 @@ paths: url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization parameters: - *90 - - &647 + - &657 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, @@ -16573,7 +17223,7 @@ paths: required: false schema: type: integer - - &648 + - &658 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 @@ -16582,7 +17232,7 @@ paths: required: false schema: type: integer - - &649 + - &659 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 @@ -16591,7 +17241,7 @@ paths: required: false schema: type: integer - - &650 + - &660 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 @@ -16674,7 +17324,7 @@ paths: repositoryName: github/example '400': *14 '403': *27 - '500': *91 + '500': *94 '503': *62 x-github: githubCloudOnly: false @@ -16707,7 +17357,7 @@ paths: description: Response content: application/json: - schema: &92 + schema: &95 title: Organization Full description: Organization Full type: object @@ -17102,7 +17752,7 @@ paths: - updated_at - archived_at examples: - default-response: &93 + default-response: &96 value: login: github id: 1 @@ -17419,17 +18069,17 @@ paths: description: Response content: application/json: - schema: *92 + schema: *95 examples: - default: *93 + default: *96 '422': description: Validation failed content: application/json: schema: oneOf: - - *94 - - *95 + - *97 + - *98 '409': *45 x-github: githubCloudOnly: false @@ -17543,7 +18193,7 @@ paths: type: integer repository_cache_usages: type: array - items: &306 + items: &311 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -17619,7 +18269,7 @@ paths: type: integer runners: type: array - items: &96 + items: &99 title: GitHub-hosted hosted runner description: A Github-hosted hosted runner. type: object @@ -17676,7 +18326,7 @@ paths: - size_gb - display_name - source - machine_size_details: &99 + machine_size_details: &102 title: Github-owned VM details. description: Provides details of a particular machine spec. type: object @@ -17781,7 +18431,7 @@ paths: - public_ip_enabled - platform examples: - default: &115 + default: &118 value: total_count: 2 runners: @@ -17908,9 +18558,9 @@ paths: description: Response content: application/json: - schema: *96 + schema: *99 examples: - default: &100 + default: &103 value: id: 5 name: My hosted ubuntu runner @@ -17965,7 +18615,7 @@ paths: type: integer images: type: array - items: &97 + items: &100 title: GitHub-hosted runner image details. description: Provides details of a hosted runner image type: object @@ -18005,7 +18655,7 @@ paths: - display_name - source examples: - default: &98 + default: &101 value: id: ubuntu-20.04 platform: linux-x64 @@ -18045,9 +18695,9 @@ paths: type: integer images: type: array - items: *97 + items: *100 examples: - default: *98 + default: *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18135,7 +18785,7 @@ paths: type: integer machine_specs: type: array - items: *99 + items: *102 examples: default: value: @@ -18205,7 +18855,7 @@ paths: url: https://docs.github.com/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization parameters: - *90 - - &101 + - &104 name: hosted_runner_id description: Unique identifier of the GitHub-hosted runner. in: path @@ -18217,9 +18867,9 @@ paths: description: Response content: application/json: - schema: *96 + schema: *99 examples: - default: *100 + default: *103 headers: Link: *57 x-github: @@ -18240,7 +18890,7 @@ paths: url: https://docs.github.com/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization parameters: - *90 - - *101 + - *104 requestBody: required: true content: @@ -18278,9 +18928,9 @@ paths: description: Response content: application/json: - schema: *96 + schema: *99 examples: - default: *100 + default: *103 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -18297,15 +18947,15 @@ paths: url: https://docs.github.com/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization parameters: - *90 - - *101 + - *104 responses: '202': description: Response content: application/json: - schema: *96 + schema: *99 examples: - default: *100 + default: *103 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -18331,7 +18981,7 @@ paths: description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &102 + schema: &105 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -18345,7 +18995,7 @@ paths: required: - include_claim_keys examples: - default: &103 + default: &106 value: include_claim_keys: - repo @@ -18372,15 +19022,15 @@ paths: required: true content: application/json: - schema: *102 + schema: *105 examples: - default: *103 + default: *106 responses: '201': description: Empty response content: application/json: - schema: &125 + schema: &128 title: Empty Object description: An object without any properties. type: object @@ -18419,7 +19069,7 @@ paths: schema: type: object properties: - enabled_repositories: &104 + enabled_repositories: &107 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -18432,7 +19082,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: &105 + allowed_actions: &108 type: string description: The permissions policy that controls the actions and reusable workflows that are allowed to run. @@ -18440,7 +19090,7 @@ paths: - all - local_only - selected - selected_actions_url: &312 + selected_actions_url: &317 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` @@ -18482,8 +19132,8 @@ paths: schema: type: object properties: - enabled_repositories: *104 - allowed_actions: *105 + enabled_repositories: *107 + allowed_actions: *108 required: - enabled_repositories examples: @@ -18530,127 +19180,7 @@ paths: type: array items: *59 examples: - default: &615 - 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: *109 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -18715,13 +19245,7 @@ paths: url: https://docs.github.com/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization parameters: - *90 - - &106 - name: repository_id - description: The unique identifier of the repository. - in: path - required: true - schema: - type: integer + - *93 responses: '204': description: Response @@ -18744,7 +19268,7 @@ paths: url: https://docs.github.com/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization parameters: - *90 - - *106 + - *93 responses: '204': description: Response @@ -18773,7 +19297,7 @@ paths: description: Response content: application/json: - schema: &107 + schema: &110 type: object properties: github_owned_allowed: @@ -18795,7 +19319,7 @@ paths: items: type: string examples: - default: &108 + default: &111 value: github_owned_allowed: true verified_allowed: false @@ -18828,9 +19352,9 @@ paths: required: false content: application/json: - schema: *107 + schema: *110 examples: - selected_actions: *108 + selected_actions: *111 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -18858,17 +19382,17 @@ paths: description: Response content: application/json: - schema: &316 + schema: &326 type: object properties: - default_workflow_permissions: &109 + default_workflow_permissions: &112 type: string description: The default workflow permissions granted to the GITHUB_TOKEN when running workflows. enum: - read - write - can_approve_pull_request_reviews: &110 + can_approve_pull_request_reviews: &113 type: boolean description: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. @@ -18876,7 +19400,7 @@ paths: - default_workflow_permissions - can_approve_pull_request_reviews examples: - default: &111 + default: &114 summary: Give read-only permission, and allow approving PRs. value: default_workflow_permissions: read @@ -18909,13 +19433,13 @@ paths: required: false content: application/json: - schema: &317 + schema: &327 type: object properties: - default_workflow_permissions: *109 - can_approve_pull_request_reviews: *110 + default_workflow_permissions: *112 + can_approve_pull_request_reviews: *113 examples: - default: *111 + default: *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18960,7 +19484,7 @@ paths: type: number runner_groups: type: array - items: &112 + items: &115 type: object properties: id: @@ -19150,9 +19674,9 @@ paths: description: Response content: application/json: - schema: *112 + schema: *115 examples: - default: &114 + default: &117 value: id: 2 name: octo-runner-group @@ -19188,7 +19712,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization parameters: - *90 - - &113 + - &116 name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path @@ -19200,7 +19724,7 @@ paths: description: Response content: application/json: - schema: *112 + schema: *115 examples: default: value: @@ -19237,7 +19761,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization parameters: - *90 - - *113 + - *116 requestBody: required: true content: @@ -19293,9 +19817,9 @@ paths: description: Response content: application/json: - schema: *112 + schema: *115 examples: - default: *114 + default: *117 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -19315,7 +19839,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization parameters: - *90 - - *113 + - *116 responses: '204': description: Response @@ -19339,7 +19863,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization parameters: - *90 - - *113 + - *116 - *17 - *19 responses: @@ -19357,9 +19881,9 @@ paths: type: number runners: type: array - items: *96 + items: *99 examples: - default: *115 + default: *118 headers: Link: *57 x-github: @@ -19382,7 +19906,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - *90 - - *113 + - *116 - *19 - *17 responses: @@ -19400,9 +19924,9 @@ paths: type: number repositories: type: array - items: *116 + items: *119 examples: - default: &607 + default: &618 value: total_count: 1 repositories: @@ -19655,7 +20179,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization parameters: - *90 - - *113 + - *116 requestBody: required: true content: @@ -19700,8 +20224,8 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - *90 - - *113 - - *106 + - *116 + - *93 responses: '204': description: Response @@ -19724,8 +20248,8 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - *90 - - *113 - - *106 + - *116 + - *93 responses: '204': description: Response @@ -19749,7 +20273,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization parameters: - *90 - - *113 + - *116 - *17 - *19 responses: @@ -19767,7 +20291,7 @@ paths: type: number runners: type: array - items: &118 + items: &121 title: Self hosted runners description: A self hosted runner type: object @@ -19801,7 +20325,7 @@ paths: type: boolean labels: type: array - items: &121 + items: &124 title: Self hosted runner label description: A label for a self hosted runner type: object @@ -19831,7 +20355,7 @@ paths: - busy - labels examples: - default: &119 + default: &122 value: total_count: 2 runners: @@ -19891,7 +20415,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization parameters: - *90 - - *113 + - *116 requestBody: required: true content: @@ -19936,8 +20460,8 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization parameters: - *90 - - *113 - - &117 + - *116 + - &120 name: runner_id description: Unique identifier of the self-hosted runner. in: path @@ -19966,8 +20490,8 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization parameters: - *90 - - *113 - - *117 + - *116 + - *120 responses: '204': description: Response @@ -20015,9 +20539,9 @@ paths: type: integer runners: type: array - items: *118 + items: *121 examples: - default: *119 + default: *122 headers: Link: *57 x-github: @@ -20049,7 +20573,7 @@ paths: application/json: schema: type: array - items: &318 + items: &328 title: Runner Application description: Runner Application type: object @@ -20074,7 +20598,7 @@ paths: - download_url - filename examples: - default: &319 + default: &329 value: - os: osx architecture: x64 @@ -20160,7 +20684,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &320 + '201': &330 description: Response content: application/json: @@ -20170,7 +20694,7 @@ paths: - runner - encoded_jit_config properties: - runner: *118 + runner: *121 encoded_jit_config: type: string description: The base64 encoded runner configuration. @@ -20233,7 +20757,7 @@ paths: description: Response content: application/json: - schema: &120 + schema: &123 title: Authentication Token description: Authentication Token type: object @@ -20275,7 +20799,7 @@ paths: - token - expires_at examples: - default: &321 + default: &331 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -20312,9 +20836,9 @@ paths: description: Response content: application/json: - schema: *120 + schema: *123 examples: - default: &322 + default: &332 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -20340,15 +20864,15 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization parameters: - *90 - - *117 + - *120 responses: '200': description: Response content: application/json: - schema: *118 + schema: *121 examples: - default: &323 + default: &333 value: id: 23 name: MBP @@ -20390,7 +20914,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization parameters: - *90 - - *117 + - *120 responses: '204': description: Response @@ -20417,9 +20941,9 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization parameters: - *90 - - *117 + - *120 responses: - '200': &122 + '200': &125 description: Response content: application/json: @@ -20433,7 +20957,7 @@ paths: type: integer labels: type: array - items: *121 + items: *124 examples: default: value: @@ -20473,7 +20997,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization parameters: - *90 - - *117 + - *120 requestBody: required: true content: @@ -20497,7 +21021,7 @@ paths: - gpu - accelerated responses: - '200': *122 + '200': *125 '404': *6 '422': *7 x-github: @@ -20522,7 +21046,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization parameters: - *90 - - *117 + - *120 requestBody: required: true content: @@ -20547,7 +21071,7 @@ paths: - gpu - accelerated responses: - '200': *122 + '200': *125 '404': *6 '422': *7 x-github: @@ -20572,9 +21096,9 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization parameters: - *90 - - *117 + - *120 responses: - '200': &324 + '200': &334 description: Response content: application/json: @@ -20588,7 +21112,7 @@ paths: type: integer labels: type: array - items: *121 + items: *124 examples: default: value: @@ -20630,8 +21154,8 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization parameters: - *90 - - *117 - - &325 + - *120 + - &335 name: name description: The name of a self-hosted runner's custom label. in: path @@ -20639,7 +21163,7 @@ paths: schema: type: string responses: - '200': *122 + '200': *125 '404': *6 '422': *7 x-github: @@ -20682,7 +21206,7 @@ paths: type: integer secrets: type: array - items: &123 + items: &126 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -20763,7 +21287,7 @@ paths: description: Response content: application/json: - schema: &337 + schema: &347 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -20798,7 +21322,7 @@ paths: - key_id - key examples: - default: &338 + default: &348 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -20824,7 +21348,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#get-an-organization-secret parameters: - *90 - - &124 + - &127 name: secret_name description: The name of the secret. in: path @@ -20836,7 +21360,7 @@ paths: description: Response content: application/json: - schema: *123 + schema: *126 examples: default: value: @@ -20867,7 +21391,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret parameters: - *90 - - *124 + - *127 requestBody: required: true content: @@ -20924,7 +21448,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *125 + schema: *128 examples: default: value: @@ -20951,7 +21475,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#delete-an-organization-secret parameters: - *90 - - *124 + - *127 responses: '204': description: Response @@ -20978,7 +21502,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - *90 - - *124 + - *127 - *19 - *17 responses: @@ -20996,9 +21520,9 @@ paths: type: integer repositories: type: array - items: *116 + items: *119 examples: - default: &128 + default: &131 value: total_count: 1 repositories: @@ -21091,7 +21615,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - *90 - - *124 + - *127 requestBody: required: true content: @@ -21144,7 +21668,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - *90 - - *124 + - *127 - name: repository_id in: path required: true @@ -21178,7 +21702,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - *90 - - *124 + - *127 - name: repository_id in: path required: true @@ -21211,7 +21735,7 @@ paths: url: https://docs.github.com/rest/actions/variables#list-organization-variables parameters: - *90 - - &311 + - &316 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)." @@ -21235,7 +21759,7 @@ paths: type: integer variables: type: array - items: &126 + items: &129 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -21373,7 +21897,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *125 + schema: *128 examples: default: value: @@ -21399,7 +21923,7 @@ paths: url: https://docs.github.com/rest/actions/variables#get-an-organization-variable parameters: - *90 - - &127 + - &130 name: name description: The name of the variable. in: path @@ -21411,7 +21935,7 @@ paths: description: Response content: application/json: - schema: *126 + schema: *129 examples: default: value: @@ -21442,7 +21966,7 @@ paths: url: https://docs.github.com/rest/actions/variables#update-an-organization-variable parameters: - *90 - - *127 + - *130 requestBody: required: true content: @@ -21505,7 +22029,7 @@ paths: url: https://docs.github.com/rest/actions/variables#delete-an-organization-variable parameters: - *90 - - *127 + - *130 responses: '204': description: Response @@ -21532,7 +22056,7 @@ paths: url: https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - *90 - - *127 + - *130 - *19 - *17 responses: @@ -21550,9 +22074,9 @@ paths: type: integer repositories: type: array - items: *116 + items: *119 examples: - default: *128 + default: *131 '409': description: Response when the visibility of the variable is not set to `selected` @@ -21579,7 +22103,7 @@ paths: url: https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - *90 - - *127 + - *130 requestBody: required: true content: @@ -21629,7 +22153,7 @@ paths: url: https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - *90 - - *127 + - *130 - name: repository_id in: path required: true @@ -21664,7 +22188,7 @@ paths: url: https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - *90 - - *127 + - *130 - name: repository_id in: path required: true @@ -21723,12 +22247,12 @@ paths: required: - subject_digests examples: - default: &636 + default: &646 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &637 + withPredicateType: &647 value: subject_digests: - sha256:abc123 @@ -21787,7 +22311,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &638 + default: &648 value: attestations_subject_digests: - sha256:abc: @@ -22081,7 +22605,7 @@ paths: bundle_url: type: string examples: - default: &351 + default: &361 value: attestations: - bundle: @@ -22200,7 +22724,7 @@ paths: type: array items: *4 examples: - default: &191 + default: &194 value: - login: octocat id: 1 @@ -22239,7 +22763,7 @@ paths: url: https://docs.github.com/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization parameters: - *90 - - &129 + - &132 name: username description: The handle for the GitHub user account. in: path @@ -22271,7 +22795,7 @@ paths: url: https://docs.github.com/rest/orgs/blocking#block-a-user-from-an-organization parameters: - *90 - - *129 + - *132 responses: '204': description: Response @@ -22292,7 +22816,7 @@ paths: url: https://docs.github.com/rest/orgs/blocking#unblock-a-user-from-an-organization parameters: - *90 - - *129 + - *132 responses: '204': description: Response @@ -22325,7 +22849,7 @@ paths: description: If specified, only campaigns with this state will be returned. in: query required: false - schema: &130 + schema: &133 title: Campaign state description: Indicates whether a campaign is open or closed type: string @@ -22351,7 +22875,7 @@ paths: application/json: schema: type: array - items: &131 + items: &134 title: Campaign summary description: The campaign metadata and alert stats. type: object @@ -22382,7 +22906,7 @@ paths: team_managers: description: The campaign team managers type: array - items: &147 + items: &150 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -22441,7 +22965,7 @@ paths: parent: anyOf: - type: 'null' - - &203 + - &206 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. @@ -22557,7 +23081,7 @@ paths: - string - 'null' format: date-time - state: *130 + state: *133 contact_link: description: The contact link of the campaign. type: @@ -22774,9 +23298,9 @@ paths: description: Response content: application/json: - schema: *131 + schema: *134 examples: - default: &132 + default: &135 value: number: 3 created_at: '2024-02-14T12:29:18Z' @@ -22859,9 +23383,9 @@ paths: description: Response content: application/json: - schema: *131 + schema: *134 examples: - default: *132 + default: *135 '404': *6 '422': description: Unprocessable Entity @@ -22939,7 +23463,7 @@ paths: - string - 'null' format: uri - state: *130 + state: *133 examples: default: value: @@ -22949,9 +23473,9 @@ paths: description: Response content: application/json: - schema: *131 + schema: *134 examples: - default: *132 + default: *135 '400': description: Bad Request content: @@ -23018,17 +23542,17 @@ paths: url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - *90 - - &376 + - &386 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: &135 + schema: &138 type: string description: The name of the tool used to generate the code scanning analysis. - - &377 + - &387 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 @@ -23036,7 +23560,7 @@ paths: or `tool_name`, but not both. in: query required: false - schema: &136 + schema: &139 type: - string - 'null' @@ -23052,7 +23576,7 @@ paths: be returned. in: query required: false - schema: &379 + schema: &389 type: string description: State of a code scanning alert. enum: @@ -23075,7 +23599,7 @@ paths: be returned. in: query required: false - schema: &380 + schema: &390 type: string description: Severity of a code scanning alert. enum: @@ -23101,13 +23625,13 @@ paths: updated_at: *54 url: *55 html_url: *56 - instances_url: &381 + instances_url: &391 type: string description: The REST API URL for fetching the list of instances for an alert. format: uri readOnly: true - state: &137 + state: &140 type: - string - 'null' @@ -23117,13 +23641,13 @@ paths: - dismissed - fixed - - fixed_at: *133 + fixed_at: *136 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *134 - dismissed_reason: &382 + dismissed_at: *137 + dismissed_reason: &392 type: - string - 'null' @@ -23134,14 +23658,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &383 + dismissed_comment: &393 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &384 + rule: &394 type: object properties: id: @@ -23202,26 +23726,26 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: &385 + tool: &395 type: object properties: - name: *135 + name: *138 version: type: - string - 'null' description: The version of the tool used to generate the code scanning analysis. - guid: *136 - most_recent_instance: &386 + guid: *139 + most_recent_instance: &396 type: object properties: - ref: &378 + ref: &388 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &396 + analysis_key: &406 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -23232,13 +23756,13 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &397 + category: &407 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: *137 + state: *140 commit_sha: type: string message: @@ -23741,7 +24265,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: *138 + code_scanning_options: *141 code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -23884,7 +24408,7 @@ paths: application/json: schema: *41 examples: - default: *139 + default: *142 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23912,9 +24436,9 @@ paths: description: Response content: application/json: - schema: *140 + schema: *143 examples: - default: *141 + default: *144 '304': *35 '403': *27 '404': *6 @@ -23966,7 +24490,7 @@ paths: - 32 - 91 responses: - '204': *142 + '204': *145 '400': *14 '403': *27 '404': *6 @@ -24001,7 +24525,7 @@ paths: application/json: schema: *41 examples: - default: *139 + default: *142 '304': *35 '403': *27 '404': *6 @@ -24285,7 +24809,7 @@ paths: - *90 - *43 responses: - '204': *142 + '204': *145 '400': *14 '403': *27 '404': *6 @@ -24423,7 +24947,7 @@ paths: default: value: default_for_new_repos: all - configuration: *139 + configuration: *142 '403': *27 '404': *6 x-github: @@ -24476,13 +25000,13 @@ paths: application/json: schema: type: array - items: *143 + items: *146 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: *144 + repository: *147 '403': *27 '404': *6 x-github: @@ -24522,7 +25046,7 @@ paths: type: integer codespaces: type: array - items: &192 + items: &195 type: object title: Codespace description: A codespace. @@ -24553,11 +25077,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *116 + repository: *119 machine: anyOf: - type: 'null' - - &409 + - &419 type: object title: Codespace machine description: A description of the machine powering a codespace. @@ -24844,7 +25368,7 @@ paths: - pulls_url - recent_folders examples: - default: &193 + default: &196 value: total_count: 3 codespaces: @@ -25254,7 +25778,7 @@ paths: stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop recent_folders: [] '304': *35 - '500': *91 + '500': *94 '401': *23 '403': *27 '404': *6 @@ -25320,7 +25844,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *91 + '500': *94 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -25375,7 +25899,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *91 + '500': *94 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -25429,7 +25953,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *91 + '500': *94 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -25468,7 +25992,7 @@ paths: type: integer secrets: type: array - items: &145 + items: &148 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -25509,7 +26033,7 @@ paths: - updated_at - visibility examples: - default: &410 + default: &420 value: total_count: 2 secrets: @@ -25547,7 +26071,7 @@ paths: description: Response content: application/json: - schema: &411 + schema: &421 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -25582,7 +26106,7 @@ paths: - key_id - key examples: - default: &412 + default: &422 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -25606,15 +26130,15 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret parameters: - *90 - - *124 + - *127 responses: '200': description: Response content: application/json: - schema: *145 + schema: *148 examples: - default: &414 + default: &424 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -25642,7 +26166,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - *90 - - *124 + - *127 requestBody: required: true content: @@ -25697,7 +26221,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *125 + schema: *128 examples: default: value: @@ -25724,7 +26248,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - *90 - - *124 + - *127 responses: '204': description: Response @@ -25750,7 +26274,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - *90 - - *124 + - *127 - *19 - *17 responses: @@ -25768,9 +26292,9 @@ paths: type: integer repositories: type: array - items: *116 + items: *119 examples: - default: *128 + default: *131 '404': *6 x-github: githubCloudOnly: false @@ -25793,7 +26317,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - *90 - - *124 + - *127 requestBody: required: true content: @@ -25844,7 +26368,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - *90 - - *124 + - *127 - name: repository_id in: path required: true @@ -25878,7 +26402,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - *90 - - *124 + - *127 - name: repository_id in: path required: true @@ -26026,7 +26550,7 @@ paths: cli: enabled public_code_suggestions: block plan_type: business - '500': *91 + '500': *94 '401': *23 '403': *27 '404': *6 @@ -26048,7 +26572,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: @@ -26081,7 +26605,7 @@ paths: currently being billed. seats: type: array - items: &195 + items: &198 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -26094,12 +26618,12 @@ paths: organization: anyOf: - type: 'null' - - *146 + - *149 assigning_team: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - *147 + - *150 - title: Enterprise Team description: Group of enterprise owners and/or members type: object @@ -26279,7 +26803,7 @@ paths: site_admin: false headers: Link: *57 - '500': *91 + '500': *94 '401': *23 '403': *27 '404': *6 @@ -26354,7 +26878,7 @@ paths: default: value: seats_created: 5 - '500': *91 + '500': *94 '401': *23 '403': *27 '404': *6 @@ -26432,7 +26956,7 @@ paths: default: value: seats_cancelled: 5 - '500': *91 + '500': *94 '401': *23 '403': *27 '404': *6 @@ -26511,7 +27035,7 @@ paths: default: value: seats_created: 5 - '500': *91 + '500': *94 '401': *23 '403': *27 '404': *6 @@ -26589,7 +27113,7 @@ paths: default: value: seats_cancelled: 5 - '500': *91 + '500': *94 '401': *23 '403': *27 '404': *6 @@ -26660,7 +27184,7 @@ paths: application/json: schema: type: array - items: &271 + items: &276 title: Copilot Usage Metrics description: Copilot usage metrics for a given day. type: object @@ -26975,7 +27499,7 @@ paths: - date additionalProperties: true examples: - default: &272 + default: &277 value: - date: '2024-06-24' total_active_users: 24 @@ -27074,10 +27598,10 @@ paths: custom_model_training_date: '2024-02-01' total_pr_summaries_created: 10 total_engaged_users: 4 - '500': *91 + '500': *94 '403': *27 '404': *6 - '422': &273 + '422': &278 description: Copilot Usage Merics API setting is disabled at the organization or enterprise level. content: @@ -27105,19 +27629,19 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - *90 - - *148 - - *149 - - *150 - *151 - *152 - *153 - *154 - *155 + - *156 + - *157 + - *158 - *46 - *38 - *39 - - *156 - - *157 + - *159 + - *160 - *17 responses: '200': @@ -27126,9 +27650,9 @@ paths: application/json: schema: type: array - items: *158 + items: *161 examples: - default: *159 + default: *162 '304': *35 '400': *14 '403': *27 @@ -27172,7 +27696,7 @@ paths: type: integer secrets: type: array - items: &160 + items: &163 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -27251,7 +27775,7 @@ paths: description: Response content: application/json: - schema: &437 + schema: &447 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -27270,7 +27794,7 @@ paths: - key_id - key examples: - default: &438 + default: &448 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -27294,13 +27818,13 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret parameters: - *90 - - *124 + - *127 responses: '200': description: Response content: application/json: - schema: *160 + schema: *163 examples: default: value: @@ -27329,7 +27853,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - *90 - - *124 + - *127 requestBody: required: true content: @@ -27384,7 +27908,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *125 + schema: *128 examples: default: value: @@ -27409,7 +27933,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret parameters: - *90 - - *124 + - *127 responses: '204': description: Response @@ -27434,7 +27958,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - *90 - - *124 + - *127 - *19 - *17 responses: @@ -27452,9 +27976,9 @@ paths: type: integer repositories: type: array - items: *116 + items: *119 examples: - default: *128 + default: *131 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27476,7 +28000,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - *90 - - *124 + - *127 requestBody: required: true content: @@ -27527,7 +28051,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - *90 - - *124 + - *127 - name: repository_id in: path required: true @@ -27559,7 +28083,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - *90 - - *124 + - *127 - name: repository_id in: path required: true @@ -27597,7 +28121,7 @@ paths: application/json: schema: type: array - items: &205 + items: &208 title: Package description: A software package type: object @@ -27650,7 +28174,7 @@ paths: repository: anyOf: - type: 'null' - - *116 + - *119 created_at: type: string format: date-time @@ -27668,7 +28192,7 @@ paths: - created_at - updated_at examples: - default: &206 + default: &209 value: - id: 197 name: hello_docker @@ -27835,7 +28359,7 @@ paths: application/json: schema: type: array - items: &183 + items: &186 title: Organization Invitation description: Organization Invitation type: object @@ -27889,7 +28413,7 @@ paths: - invitation_teams_url - node_id examples: - default: &184 + default: &187 value: - id: 1 login: monalisa @@ -27956,7 +28480,7 @@ paths: application/json: schema: type: array - items: &161 + items: &164 title: Org Hook description: Org Hook type: object @@ -28141,9 +28665,9 @@ paths: description: Response content: application/json: - schema: *161 + schema: *164 examples: - default: &162 + default: &165 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -28191,7 +28715,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook parameters: - *90 - - &163 + - &166 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. @@ -28204,9 +28728,9 @@ paths: description: Response content: application/json: - schema: *161 + schema: *164 examples: - default: *162 + default: *165 '404': *6 x-github: githubCloudOnly: false @@ -28234,7 +28758,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook parameters: - *90 - - *163 + - *166 requestBody: required: false content: @@ -28280,7 +28804,7 @@ paths: description: Response content: application/json: - schema: *161 + schema: *164 examples: default: value: @@ -28322,7 +28846,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook parameters: - *90 - - *163 + - *166 responses: '204': description: Response @@ -28350,7 +28874,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - *90 - - *163 + - *166 responses: '200': description: Response @@ -28381,7 +28905,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - *90 - - *163 + - *166 requestBody: required: false content: @@ -28432,9 +28956,9 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - *90 - - *163 + - *166 - *17 - - *164 + - *167 responses: '200': description: Response @@ -28442,9 +28966,9 @@ paths: application/json: schema: type: array - items: *165 + items: *168 examples: - default: *166 + default: *169 '400': *14 '422': *15 x-github: @@ -28470,16 +28994,16 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - *90 - - *163 + - *166 - *16 responses: '200': description: Response content: application/json: - schema: *167 + schema: *170 examples: - default: *168 + default: *171 '400': *14 '422': *15 x-github: @@ -28505,7 +29029,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - *90 - - *163 + - *166 - *16 responses: '202': *37 @@ -28535,7 +29059,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook parameters: - *90 - - *163 + - *166 responses: '204': description: Response @@ -28558,7 +29082,7 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor parameters: - *90 - - &173 + - &176 name: actor_type in: path description: The type of the actor @@ -28571,14 +29095,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &174 + - &177 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &169 + - &172 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`.' @@ -28586,7 +29110,7 @@ paths: required: true schema: type: string - - &170 + - &173 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) @@ -28681,12 +29205,12 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-subject-stats parameters: - *90 - - *169 - - *170 + - *172 + - *173 - *19 - *17 - *46 - - &179 + - &182 name: sort description: The property to sort the results by. in: query @@ -28766,14 +29290,14 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats parameters: - *90 - - *169 - - *170 + - *172 + - *173 responses: '200': description: Response content: application/json: - schema: &171 + schema: &174 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -28789,7 +29313,7 @@ paths: type: integer format: int64 examples: - default: &172 + default: &175 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -28810,23 +29334,23 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user parameters: - *90 - - &175 + - &178 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *169 - - *170 + - *172 + - *173 responses: '200': description: Response content: application/json: - schema: *171 + schema: *174 examples: - default: *172 + default: *175 x-github: enabledForGitHubApps: true category: orgs @@ -28845,18 +29369,18 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor parameters: - *90 - - *169 - - *170 + - *172 - *173 - - *174 + - *176 + - *177 responses: '200': description: Response content: application/json: - schema: *171 + schema: *174 examples: - default: *172 + default: *175 x-github: enabledForGitHubApps: true category: orgs @@ -28874,9 +29398,9 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-time-stats parameters: - *90 - - *169 - - *170 - - &176 + - *172 + - *173 + - &179 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -28889,7 +29413,7 @@ paths: description: Response content: application/json: - schema: &177 + schema: &180 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -28905,7 +29429,7 @@ paths: type: integer format: int64 examples: - default: &178 + default: &181 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -28942,18 +29466,18 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user parameters: - *90 - - *175 - - *169 - - *170 - - *176 + - *178 + - *172 + - *173 + - *179 responses: '200': description: Response content: application/json: - schema: *177 + schema: *180 examples: - default: *178 + default: *181 x-github: enabledForGitHubApps: true category: orgs @@ -28971,19 +29495,19 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor parameters: - *90 - - *173 - - *174 - - *169 - - *170 - *176 + - *177 + - *172 + - *173 + - *179 responses: '200': description: Response content: application/json: - schema: *177 + schema: *180 examples: - default: *178 + default: *181 x-github: enabledForGitHubApps: true category: orgs @@ -29001,13 +29525,13 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-user-stats parameters: - *90 - - *175 - - *169 - - *170 + - *178 + - *172 + - *173 - *19 - *17 - *46 - - *179 + - *182 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -29091,7 +29615,7 @@ paths: application/json: schema: *20 examples: - default: &476 + default: &486 value: id: 1 account: @@ -29257,12 +29781,12 @@ paths: application/json: schema: anyOf: - - &181 + - &184 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &180 + limit: &183 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -29290,7 +29814,7 @@ paths: properties: {} additionalProperties: false examples: - default: &182 + default: &185 value: limit: collaborators_only origin: organization @@ -29319,13 +29843,13 @@ paths: required: true content: application/json: - schema: &477 + schema: &487 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *180 + limit: *183 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -29350,9 +29874,9 @@ paths: description: Response content: application/json: - schema: *181 + schema: *184 examples: - default: *182 + default: *185 '422': *15 x-github: githubCloudOnly: false @@ -29428,9 +29952,9 @@ paths: application/json: schema: type: array - items: *183 + items: *186 examples: - default: *184 + default: *187 headers: Link: *57 '404': *6 @@ -29507,7 +30031,7 @@ paths: description: Response content: application/json: - schema: *183 + schema: *186 examples: default: value: @@ -29562,7 +30086,7 @@ paths: url: https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation parameters: - *90 - - &185 + - &188 name: invitation_id description: The unique identifier of the invitation. in: path @@ -29593,7 +30117,7 @@ paths: url: https://docs.github.com/rest/orgs/members#list-organization-invitation-teams parameters: - *90 - - *185 + - *188 - *17 - *19 responses: @@ -29603,9 +30127,9 @@ paths: application/json: schema: type: array - items: *147 + items: *150 examples: - default: &204 + default: &207 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -29648,7 +30172,7 @@ paths: application/json: schema: type: array - items: *186 + items: *189 examples: default: value: @@ -29736,9 +30260,9 @@ paths: description: Response content: application/json: - schema: *186 + schema: *189 examples: - default: &187 + default: &190 value: id: 410 node_id: IT_kwDNAd3NAZo @@ -29771,7 +30295,7 @@ paths: url: https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization parameters: - *90 - - &188 + - &191 name: issue_type_id description: The unique identifier of the issue type. in: path @@ -29827,9 +30351,9 @@ paths: description: Response content: application/json: - schema: *186 + schema: *189 examples: - default: *187 + default: *190 '404': *6 '422': *7 x-github: @@ -29854,7 +30378,7 @@ paths: url: https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization parameters: - *90 - - *188 + - *191 responses: '204': description: Response @@ -29917,7 +30441,7 @@ paths: - closed - all default: open - - *189 + - *192 - name: type description: Can be the name of an issue type. in: query @@ -29948,7 +30472,7 @@ paths: type: array items: *74 examples: - default: *190 + default: *193 headers: Link: *57 '404': *6 @@ -30008,7 +30532,7 @@ paths: type: array items: *4 examples: - default: *191 + default: *194 headers: Link: *57 '422': *15 @@ -30029,7 +30553,7 @@ paths: url: https://docs.github.com/rest/orgs/members#check-organization-membership-for-a-user parameters: - *90 - - *129 + - *132 responses: '204': description: Response if requester is an organization member and user is @@ -30064,7 +30588,7 @@ paths: url: https://docs.github.com/rest/orgs/members#remove-an-organization-member parameters: - *90 - - *129 + - *132 responses: '204': description: Response @@ -30091,7 +30615,7 @@ paths: - *17 - *19 - *90 - - *129 + - *132 responses: '200': description: Response @@ -30107,11 +30631,11 @@ paths: type: integer codespaces: type: array - items: *192 + items: *195 examples: - default: *193 + default: *196 '304': *35 - '500': *91 + '500': *94 '401': *23 '403': *27 '404': *6 @@ -30135,8 +30659,8 @@ paths: url: https://docs.github.com/rest/codespaces/organizations#delete-a-codespace-from-the-organization parameters: - *90 - - *129 - - &194 + - *132 + - &197 name: codespace_name in: path required: true @@ -30146,7 +30670,7 @@ paths: responses: '202': *37 '304': *35 - '500': *91 + '500': *94 '401': *23 '403': *27 '404': *6 @@ -30170,16 +30694,16 @@ paths: url: https://docs.github.com/rest/codespaces/organizations#stop-a-codespace-for-an-organization-user parameters: - *90 - - *129 - - *194 + - *132 + - *197 responses: '200': description: Response content: application/json: - schema: *192 + schema: *195 examples: - default: &408 + default: &418 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -30321,7 +30845,7 @@ paths: recent_folders: [] template: '304': *35 - '500': *91 + '500': *94 '401': *23 '403': *27 '404': *6 @@ -30340,7 +30864,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. @@ -30353,13 +30877,13 @@ paths: url: https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-user parameters: - *90 - - *129 + - *132 responses: '200': description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *195 + schema: *198 examples: default: value: @@ -30402,7 +30926,7 @@ paths: members_url: https://api.github.com/teams/1/members{/member} repositories_url: https://api.github.com/teams/1/repos parent: - '500': *91 + '500': *94 '401': *23 '403': *27 '404': *6 @@ -30428,13 +30952,13 @@ paths: url: https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user parameters: - *90 - - *129 + - *132 responses: '200': description: Response content: application/json: - schema: &196 + schema: &199 title: Org Membership description: Org Membership type: object @@ -30483,7 +31007,7 @@ paths: format: uri examples: - https://api.github.com/orgs/octocat - organization: *146 + organization: *149 user: anyOf: - type: 'null' @@ -30503,7 +31027,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &197 + response-if-user-has-an-active-admin-membership-with-organization: &200 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -30572,7 +31096,7 @@ paths: url: https://docs.github.com/rest/orgs/members#set-organization-membership-for-a-user parameters: - *90 - - *129 + - *132 requestBody: required: false content: @@ -30600,9 +31124,9 @@ paths: description: Response content: application/json: - schema: *196 + schema: *199 examples: - response-if-user-already-had-membership-with-organization: *197 + response-if-user-already-had-membership-with-organization: *200 '422': *15 '403': *27 x-github: @@ -30627,7 +31151,7 @@ paths: url: https://docs.github.com/rest/orgs/members#remove-organization-membership-for-a-user parameters: - *90 - - *129 + - *132 responses: '204': description: Response @@ -30674,7 +31198,7 @@ paths: application/json: schema: type: array - items: &198 + items: &201 title: Migration description: A migration. type: object @@ -31012,7 +31536,7 @@ paths: description: Response content: application/json: - schema: *198 + schema: *201 examples: default: value: @@ -31191,7 +31715,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status parameters: - *90 - - &199 + - &202 name: migration_id description: The unique identifier of the migration. in: path @@ -31219,7 +31743,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *198 + schema: *201 examples: default: value: @@ -31389,7 +31913,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive parameters: - *90 - - *199 + - *202 responses: '302': description: Response @@ -31411,7 +31935,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive parameters: - *90 - - *199 + - *202 responses: '204': description: Response @@ -31435,8 +31959,8 @@ paths: url: https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository parameters: - *90 - - *199 - - &620 + - *202 + - &630 name: repo_name description: repo_name parameter in: path @@ -31464,7 +31988,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - *90 - - *199 + - *202 - *17 - *19 responses: @@ -31474,9 +31998,9 @@ paths: application/json: schema: type: array - items: *116 + items: *119 examples: - default: &211 + default: &214 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -31629,7 +32153,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &202 + items: &205 title: Organization Role description: Organization roles type: object @@ -31779,7 +32303,7 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team parameters: - *90 - - &200 + - &203 name: team_slug description: The slug of the team name. in: path @@ -31811,8 +32335,8 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-team parameters: - *90 - - *200 - - &201 + - *203 + - &204 name: role_id description: The unique identifier of the role. in: path @@ -31848,8 +32372,8 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-team parameters: - *90 - - *200 - - *201 + - *203 + - *204 responses: '204': description: Response @@ -31875,7 +32399,7 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-user parameters: - *90 - - *129 + - *132 responses: '204': description: Response @@ -31901,8 +32425,8 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-user parameters: - *90 - - *129 - - *201 + - *132 + - *204 responses: '204': description: Response @@ -31933,8 +32457,8 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-user parameters: - *90 - - *129 - - *201 + - *132 + - *204 responses: '204': description: Response @@ -31963,13 +32487,13 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role parameters: - *90 - - *201 + - *204 responses: '200': description: Response content: application/json: - schema: *202 + schema: *205 examples: default: value: @@ -32020,7 +32544,7 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role parameters: - *90 - - *201 + - *204 - *17 - *19 responses: @@ -32099,7 +32623,7 @@ paths: parent: anyOf: - type: 'null' - - *203 + - *206 required: - id - node_id @@ -32113,7 +32637,7 @@ paths: - slug - parent examples: - default: *204 + default: *207 headers: Link: *57 '404': @@ -32143,7 +32667,7 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role parameters: - *90 - - *201 + - *204 - *17 - *19 responses: @@ -32172,7 +32696,7 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: *203 + items: *206 name: type: - string @@ -32289,7 +32813,7 @@ paths: - type - url examples: - default: *191 + default: *194 headers: Link: *57 '404': @@ -32340,7 +32864,7 @@ paths: type: array items: *4 examples: - default: *191 + default: *194 headers: Link: *57 x-github: @@ -32366,7 +32890,7 @@ paths: url: https://docs.github.com/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator parameters: - *90 - - *129 + - *132 requestBody: required: false content: @@ -32424,7 +32948,7 @@ paths: url: https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization parameters: - *90 - - *129 + - *132 responses: '204': description: Response @@ -32482,7 +33006,7 @@ paths: - nuget - container - *90 - - &622 + - &632 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -32518,12 +33042,12 @@ paths: application/json: schema: type: array - items: *205 + items: *208 examples: - default: *206 + default: *209 '403': *27 '401': *23 - '400': &624 + '400': &634 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -32545,7 +33069,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization parameters: - - &207 + - &210 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 @@ -32563,7 +33087,7 @@ paths: - docker - nuget - container - - &208 + - &211 name: package_name description: The name of the package. in: path @@ -32576,7 +33100,7 @@ paths: description: Response content: application/json: - schema: *205 + schema: *208 examples: default: value: @@ -32628,8 +33152,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization parameters: - - *207 - - *208 + - *210 + - *211 - *90 responses: '204': @@ -32662,8 +33186,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization parameters: - - *207 - - *208 + - *210 + - *211 - *90 - name: token description: package token @@ -32696,8 +33220,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization parameters: - - *207 - - *208 + - *210 + - *211 - *90 - *19 - *17 @@ -32718,7 +33242,7 @@ paths: application/json: schema: type: array - items: &209 + items: &212 title: Package Version description: A version of a software package type: object @@ -32853,10 +33377,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization parameters: - - *207 - - *208 + - *210 + - *211 - *90 - - &210 + - &213 name: package_version_id description: Unique identifier of the package version. in: path @@ -32868,7 +33392,7 @@ paths: description: Response content: application/json: - schema: *209 + schema: *212 examples: default: value: @@ -32904,10 +33428,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization parameters: - - *207 - - *208 - - *90 - *210 + - *211 + - *90 + - *213 responses: '204': description: Response @@ -32939,10 +33463,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization parameters: - - *207 - - *208 - - *90 - *210 + - *211 + - *90 + - *213 responses: '204': description: Response @@ -32972,7 +33496,7 @@ paths: - *90 - *17 - *19 - - &212 + - &215 name: sort description: The property by which to sort the results. in: query @@ -32983,7 +33507,7 @@ paths: - created_at default: created_at - *46 - - &213 + - &216 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -32995,7 +33519,7 @@ paths: type: string examples: - owner[]=octocat1,owner[]=octocat2 - - &214 + - &217 name: repository description: The name of the repository to use to filter the results. in: query @@ -33004,7 +33528,7 @@ paths: type: string examples: - Hello-World - - &215 + - &218 name: permission description: The permission to use to filter the results. in: query @@ -33013,7 +33537,7 @@ paths: type: string examples: - issues_read - - &216 + - &219 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) @@ -33023,7 +33547,7 @@ paths: schema: type: string format: date-time - - &217 + - &220 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) @@ -33033,7 +33557,7 @@ paths: schema: type: string format: date-time - - &218 + - &221 name: token_id description: The ID of the token in: query @@ -33046,7 +33570,7 @@ paths: examples: - token_id[]=1,token_id[]=2 responses: - '500': *91 + '500': *94 '422': *15 '404': *6 '403': *27 @@ -33243,7 +33767,7 @@ paths: action: deny reason: Access is too broad. responses: - '500': *91 + '500': *94 '422': *15 '404': *6 '403': *27 @@ -33305,11 +33829,11 @@ paths: action: deny reason: This request is denied because the access is too broad. responses: - '500': *91 + '500': *94 '422': *15 '404': *6 '403': *27 - '204': *142 + '204': *145 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33341,7 +33865,7 @@ paths: - *17 - *19 responses: - '500': *91 + '500': *94 '404': *6 '403': *27 '200': @@ -33350,9 +33874,9 @@ paths: application/json: schema: type: array - items: *116 + items: *119 examples: - default: *211 + default: *214 headers: Link: *57 x-github: @@ -33378,16 +33902,16 @@ paths: - *90 - *17 - *19 - - *212 - - *46 - - *213 - - *214 - *215 + - *46 - *216 - *217 - *218 + - *219 + - *220 + - *221 responses: - '500': *91 + '500': *94 '422': *15 '404': *6 '403': *27 @@ -33571,7 +34095,7 @@ paths: - 1296269 - 1296280 responses: - '500': *91 + '500': *94 '404': *6 '202': *37 '403': *27 @@ -33624,9 +34148,9 @@ paths: value: action: revoke responses: - '500': *91 + '500': *94 '404': *6 - '204': *142 + '204': *145 '403': *27 '422': *15 x-github: @@ -33658,7 +34182,7 @@ paths: - *17 - *19 responses: - '500': *91 + '500': *94 '404': *6 '403': *27 '200': @@ -33667,9 +34191,9 @@ paths: application/json: schema: type: array - items: *116 + items: *119 examples: - default: *211 + default: *214 headers: Link: *57 x-github: @@ -33711,7 +34235,7 @@ paths: type: integer configurations: type: array - items: &219 + items: &222 title: Organization private registry description: Private registry configuration for an organization type: object @@ -33970,7 +34494,7 @@ paths: - created_at - updated_at examples: - org-private-registry-with-selected-visibility: &220 + org-private-registry-with-selected-visibility: &223 value: name: MAVEN_REPOSITORY_SECRET registry_type: maven_repository @@ -34062,15 +34586,15 @@ paths: url: https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization parameters: - *90 - - *124 + - *127 responses: '200': description: The specified private registry configuration for the organization content: application/json: - schema: *219 + schema: *222 examples: - default: *220 + default: *223 '404': *6 x-github: githubCloudOnly: false @@ -34092,7 +34616,7 @@ paths: url: https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization parameters: - *90 - - *124 + - *127 requestBody: required: true content: @@ -34189,7 +34713,7 @@ paths: url: https://docs.github.com/rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization parameters: - *90 - - *124 + - *127 responses: '204': description: Response @@ -34235,7 +34759,7 @@ paths: application/json: schema: type: array - items: &221 + items: &224 title: Project description: Projects are a way to organize columns and cards of work. @@ -34417,7 +34941,7 @@ paths: description: Response content: application/json: - schema: *221 + schema: *224 examples: default: value: @@ -34455,7 +34979,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': &298 + '410': &303 description: Gone content: application/json: @@ -34490,7 +35014,7 @@ paths: application/json: schema: type: array - items: &222 + items: &225 title: Organization Custom Property description: Custom property defined on an organization type: object @@ -34566,7 +35090,7 @@ paths: - property_name - value_type examples: - default: &223 + default: &226 value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -34625,7 +35149,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *222 + items: *225 minItems: 1 maxItems: 100 required: @@ -34655,9 +35179,9 @@ paths: application/json: schema: type: array - items: *222 + items: *225 examples: - default: *223 + default: *226 '403': *27 '404': *6 x-github: @@ -34679,7 +35203,7 @@ paths: url: https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization parameters: - *90 - - &224 + - &227 name: custom_property_name description: The custom property name in: path @@ -34691,9 +35215,9 @@ paths: description: Response content: application/json: - schema: *222 + schema: *225 examples: - default: &225 + default: &228 value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -34728,7 +35252,7 @@ paths: url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization parameters: - *90 - - *224 + - *227 requestBody: required: true content: @@ -34806,9 +35330,9 @@ paths: description: Response content: application/json: - schema: *222 + schema: *225 examples: - default: *225 + default: *228 '403': *27 '404': *6 x-github: @@ -34832,9 +35356,9 @@ paths: url: https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization parameters: - *90 - - *224 + - *227 responses: - '204': *142 + '204': *145 '403': *27 '404': *6 x-github: @@ -34896,7 +35420,7 @@ paths: - octocat/Hello-World properties: type: array - items: &226 + items: &229 title: Custom Property Value description: Custom property name and associated value type: object @@ -34986,7 +35510,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *226 + items: *229 required: - repository_names - properties @@ -35039,7 +35563,7 @@ paths: type: array items: *4 examples: - default: *191 + default: *194 headers: Link: *57 x-github: @@ -35059,7 +35583,7 @@ paths: url: https://docs.github.com/rest/orgs/members#check-public-organization-membership-for-a-user parameters: - *90 - - *129 + - *132 responses: '204': description: Response if user is a public member @@ -35084,7 +35608,7 @@ paths: url: https://docs.github.com/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user parameters: - *90 - - *129 + - *132 responses: '204': description: Response @@ -35106,7 +35630,7 @@ paths: url: https://docs.github.com/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user parameters: - *90 - - *129 + - *132 responses: '204': description: Response @@ -35176,9 +35700,9 @@ paths: application/json: schema: type: array - items: *116 + items: *119 examples: - default: *211 + default: *214 headers: Link: *57 x-github: @@ -35381,7 +35905,7 @@ paths: description: Response content: application/json: - schema: &300 + schema: &305 title: Full Repository description: Full Repository type: object @@ -35846,7 +36370,7 @@ paths: description: Whether anonymous git access is allowed. default: true type: boolean - code_of_conduct: &427 + code_of_conduct: &437 title: Code Of Conduct Simple description: Code of Conduct Simple type: object @@ -35876,7 +36400,7 @@ paths: - key - name - html_url - security_and_analysis: *227 + security_and_analysis: *230 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -35960,7 +36484,7 @@ paths: - network_count - subscribers_count examples: - default: &302 + default: &307 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -36481,7 +37005,7 @@ paths: - *90 - *17 - *19 - - &542 + - &552 name: targets description: | A comma-separated list of rule targets to filter by. @@ -36500,7 +37024,7 @@ paths: application/json: schema: type: array - items: &253 + items: &256 title: Repository ruleset type: object description: A set of rules to apply when specified conditions are @@ -36535,7 +37059,7 @@ paths: source: type: string description: The name of the source - enforcement: &230 + enforcement: &233 type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins @@ -36548,7 +37072,7 @@ paths: bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: &231 + items: &234 title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset @@ -36614,7 +37138,7 @@ paths: description: The html URL of the ruleset conditions: anyOf: - - &228 + - &231 title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name @@ -36638,7 +37162,7 @@ paths: match. items: type: string - - &232 + - &235 title: Organization ruleset conditions type: object description: |- @@ -36652,7 +37176,7 @@ paths: description: Conditions to target repositories by name and refs by name allOf: - - *228 + - *231 - title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition @@ -36686,7 +37210,7 @@ paths: description: Conditions to target repositories by id and refs by name allOf: - - *228 + - *231 - title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition @@ -36708,7 +37232,7 @@ paths: description: Conditions to target repositories by property and refs by name allOf: - - *228 + - *231 - title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition @@ -36721,7 +37245,7 @@ paths: description: The repository properties and values to include. All of these properties must match for the condition to pass. - items: &229 + items: &232 title: Repository ruleset property targeting definition type: object @@ -36754,7 +37278,7 @@ paths: description: The repository properties and values to exclude. The condition will not pass if any of these properties match. - items: *229 + items: *232 required: - repository_property type: @@ -36762,12 +37286,12 @@ paths: - object rules: type: array - items: &543 + items: &553 title: Repository Rule type: object description: A repository rule. oneOf: - - &233 + - &236 title: creation description: Only allow users with bypass permission to create matching refs. @@ -36779,7 +37303,7 @@ paths: type: string enum: - creation - - &234 + - &237 title: update description: Only allow users with bypass permission to update matching refs. @@ -36800,7 +37324,7 @@ paths: repository required: - update_allows_fetch_and_merge - - &235 + - &238 title: deletion description: Only allow users with bypass permissions to delete matching refs. @@ -36812,7 +37336,7 @@ paths: type: string enum: - deletion - - &236 + - &239 title: required_linear_history description: Prevent merge commits from being pushed to matching refs. @@ -36824,7 +37348,7 @@ paths: type: string enum: - required_linear_history - - &541 + - &551 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -36902,7 +37426,7 @@ paths: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - - &237 + - &240 title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that @@ -36926,7 +37450,7 @@ paths: type: string required: - required_deployment_environments - - &238 + - &241 title: required_signatures description: Commits pushed to matching refs must have verified signatures. @@ -36938,7 +37462,7 @@ paths: type: string enum: - required_signatures - - &239 + - &242 title: pull_request description: Require all commits be made to a non-target branch and submitted via a pull request before they can @@ -37000,7 +37524,7 @@ paths: - require_last_push_approval - required_approving_review_count - required_review_thread_resolution - - &240 + - &243 title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be @@ -37048,7 +37572,7 @@ paths: required: - required_status_checks - strict_required_status_checks_policy - - &241 + - &244 title: non_fast_forward description: Prevent users with push access from force pushing to refs. @@ -37060,7 +37584,7 @@ paths: type: string enum: - non_fast_forward - - &242 + - &245 title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule @@ -37096,7 +37620,7 @@ paths: required: - operator - pattern - - &243 + - &246 title: commit_author_email_pattern description: Parameters to be used for the commit_author_email_pattern rule @@ -37132,7 +37656,7 @@ paths: required: - operator - pattern - - &244 + - &247 title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule @@ -37168,7 +37692,7 @@ paths: required: - operator - pattern - - &245 + - &248 title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule @@ -37204,7 +37728,7 @@ paths: required: - operator - pattern - - &246 + - &249 title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule @@ -37240,7 +37764,7 @@ paths: required: - operator - pattern - - &247 + - &250 title: file_path_restriction description: Prevent commits that include changes in specified file and folder paths from being pushed to the commit @@ -37265,7 +37789,7 @@ paths: type: string required: - restricted_file_paths - - &248 + - &251 title: max_file_path_length description: Prevent commits that include file paths that exceed the specified character limit from being pushed @@ -37289,7 +37813,7 @@ paths: maximum: 32767 required: - max_file_path_length - - &249 + - &252 title: file_extension_restriction description: Prevent commits that include files with specified file extensions from being pushed to the commit graph. @@ -37312,7 +37836,7 @@ paths: type: string required: - restricted_file_extensions - - &250 + - &253 title: max_file_size description: Prevent commits with individual files that exceed the specified limit from being pushed to the commit @@ -37337,7 +37861,7 @@ paths: maximum: 100 required: - max_file_size - - &251 + - &254 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -37387,7 +37911,7 @@ paths: - repository_id required: - workflows - - &252 + - &255 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, @@ -37484,7 +38008,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *91 + '500': *94 post: summary: Create an organization repository ruleset description: Create a repository ruleset for an organization. @@ -37521,23 +38045,20 @@ paths: - push - repository default: branch - enforcement: *230 + enforcement: *233 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *231 - conditions: *232 + items: *234 + conditions: *235 rules: type: array description: An array of rules within the ruleset. - items: &255 + items: &258 title: Repository Rule type: object description: A repository rule. oneOf: - - *233 - - *234 - - *235 - *236 - *237 - *238 @@ -37555,6 +38076,9 @@ paths: - *250 - *251 - *252 + - *253 + - *254 + - *255 required: - name - enforcement @@ -37592,9 +38116,9 @@ paths: description: Response content: application/json: - schema: *253 + schema: *256 examples: - default: &254 + default: &257 value: id: 21 name: super cool ruleset @@ -37634,7 +38158,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *91 + '500': *94 "/orgs/{org}/rulesets/rule-suites": get: summary: List organization rule suites @@ -37649,7 +38173,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - *90 - - &544 + - &554 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 @@ -37664,7 +38188,7 @@ paths: in: query schema: type: string - - &545 + - &555 name: time_period description: |- The time period to filter by. @@ -37680,14 +38204,14 @@ paths: - week - month default: day - - &546 + - &556 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 - - &547 + - &557 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -37707,7 +38231,7 @@ paths: description: Response content: application/json: - schema: &548 + schema: &558 title: Rule Suites description: Response type: array @@ -37763,7 +38287,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &549 + default: &559 value: - id: 21 actor_id: 12 @@ -37787,7 +38311,7 @@ paths: result: pass evaluation_result: fail '404': *6 - '500': *91 + '500': *94 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37807,7 +38331,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *90 - - &550 + - &560 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -37823,7 +38347,7 @@ paths: description: Response content: application/json: - schema: &551 + schema: &561 title: Rule Suite description: Response type: object @@ -37930,7 +38454,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &552 + default: &562 value: id: 21 actor_id: 12 @@ -37965,7 +38489,7 @@ paths: result: fail rule_type: commit_message_pattern '404': *6 - '500': *91 + '500': *94 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38003,11 +38527,11 @@ paths: description: Response content: application/json: - schema: *253 + schema: *256 examples: - default: *254 + default: *257 '404': *6 - '500': *91 + '500': *94 put: summary: Update an organization repository ruleset description: Update a ruleset for an organization. @@ -38049,16 +38573,16 @@ paths: - tag - push - repository - enforcement: *230 + enforcement: *233 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *231 - conditions: *232 + items: *234 + conditions: *235 rules: description: An array of rules within the ruleset. type: array - items: *255 + items: *258 examples: default: value: @@ -38093,11 +38617,11 @@ paths: description: Response content: application/json: - schema: *253 + schema: *256 examples: - default: *254 + default: *257 '404': *6 - '500': *91 + '500': *94 delete: summary: Delete an organization repository ruleset description: Delete a ruleset for an organization. @@ -38124,7 +38648,7 @@ paths: '204': description: Response '404': *6 - '500': *91 + '500': *94 "/orgs/{org}/rulesets/{ruleset_id}/history": get: summary: Get organization ruleset history @@ -38152,7 +38676,7 @@ paths: application/json: schema: type: array - items: &256 + items: &259 title: Ruleset version type: object description: The historical version of a ruleset @@ -38176,7 +38700,7 @@ paths: type: string format: date-time examples: - default: &554 + default: &564 value: - version_id: 3 actor: @@ -38194,7 +38718,7 @@ paths: type: User updated_at: '2024-08-23T16:29:47Z' '404': *6 - '500': *91 + '500': *94 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38229,9 +38753,9 @@ paths: description: Response content: application/json: - schema: &555 + schema: &565 allOf: - - *256 + - *259 - type: object required: - state @@ -38278,7 +38802,7 @@ paths: operator: contains pattern: github '404': *6 - '500': *91 + '500': *94 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38301,14 +38825,14 @@ paths: url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - *90 - - *257 - - *258 - - *259 - *260 + - *261 + - *262 + - *263 - *46 - *19 - *17 - - &556 + - &566 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 @@ -38318,7 +38842,7 @@ paths: required: false schema: type: string - - &557 + - &567 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 @@ -38328,10 +38852,10 @@ paths: required: false schema: type: string - - *261 - - *262 - - *263 - *264 + - *265 + - *266 + - *267 responses: '200': description: Response @@ -38339,9 +38863,9 @@ paths: application/json: schema: type: array - items: *265 + items: *268 examples: - default: *266 + default: *269 headers: Link: *57 '404': *6 @@ -38351,6 +38875,237 @@ 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: + - *90 + 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: &271 + type: + - string + - 'null' + 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. + provider_pattern_overrides: + type: array + description: Overrides for partner patterns. + items: &270 + type: object + properties: + token_type: + type: string + description: The ID of the pattern. + custom_pattern_version: + type: + - string + - 'null' + description: The version of this pattern if it's a custom + pattern. + 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 + - 'null' + 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 + - + 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: *270 + 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': *27 + '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: + - *90 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + pattern_config_version: *271 + 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: *271 + 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': *27 + '404': *6 + '409': *45 + '422': *15 "/orgs/{org}/security-advisories": get: summary: List repository security advisories for an organization @@ -38411,7 +39166,7 @@ paths: application/json: schema: type: array - items: &578 + items: &588 description: A repository security advisory. type: object properties: @@ -38655,7 +39410,7 @@ paths: login: type: string description: The username of the user credited. - type: *267 + type: *272 credits_detailed: type: - array @@ -38666,7 +39421,7 @@ paths: type: object properties: user: *4 - type: *267 + type: *272 state: type: string description: The state of the user's acceptance of the @@ -38692,7 +39447,7 @@ paths: - array - 'null' description: A list of teams that collaborate on the advisory. - items: *147 + items: *150 private_fork: readOnly: true description: A temporary private fork of the advisory's repository @@ -38730,7 +39485,7 @@ paths: - private_fork additionalProperties: false examples: - default: &579 + default: &589 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -39117,9 +39872,9 @@ paths: application/json: schema: type: array - items: *203 + items: *206 examples: - default: *204 + default: *207 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39143,7 +39898,7 @@ paths: url: https://docs.github.com/rest/orgs/security-managers#add-a-security-manager-team parameters: - *90 - - *200 + - *203 responses: '204': description: Response @@ -39169,7 +39924,7 @@ paths: url: https://docs.github.com/rest/orgs/security-managers#remove-a-security-manager-team parameters: - *90 - - *200 + - *203 responses: '204': description: Response @@ -39204,7 +39959,7 @@ paths: description: Response content: application/json: - schema: &641 + schema: &651 type: object properties: total_minutes_used: @@ -39274,7 +40029,7 @@ paths: - included_minutes - minutes_used_breakdown examples: - default: &642 + default: &652 value: total_minutes_used: 305 total_paid_minutes_used: 0 @@ -39310,7 +40065,7 @@ paths: description: Response content: application/json: - schema: &643 + schema: &653 type: object properties: total_gigabytes_bandwidth_used: @@ -39328,7 +40083,7 @@ paths: - total_paid_gigabytes_bandwidth_used - included_gigabytes_bandwidth examples: - default: &644 + default: &654 value: total_gigabytes_bandwidth_used: 50 total_paid_gigabytes_bandwidth_used: 40 @@ -39360,7 +40115,7 @@ paths: description: Response content: application/json: - schema: &645 + schema: &655 type: object properties: days_left_in_billing_cycle: @@ -39378,7 +40133,7 @@ paths: - estimated_paid_storage_for_month - estimated_storage_for_month examples: - default: &646 + default: &656 value: days_left_in_billing_cycle: 20 estimated_paid_storage_for_month: 15 @@ -39420,7 +40175,7 @@ paths: type: integer network_configurations: type: array - items: &268 + items: &273 title: Hosted compute network configuration description: A hosted compute network configuration. type: object @@ -39545,9 +40300,9 @@ paths: description: Response content: application/json: - schema: *268 + schema: *273 examples: - default: &269 + default: &274 value: id: 123456789ABCDEF name: My network configuration @@ -39576,7 +40331,7 @@ paths: url: https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization parameters: - *90 - - &270 + - &275 name: network_configuration_id description: Unique identifier of the hosted compute network configuration. in: path @@ -39588,9 +40343,9 @@ paths: description: Response content: application/json: - schema: *268 + schema: *273 examples: - default: *269 + default: *274 headers: Link: *57 x-github: @@ -39612,7 +40367,7 @@ paths: url: https://docs.github.com/rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization parameters: - *90 - - *270 + - *275 requestBody: required: true content: @@ -39651,9 +40406,9 @@ paths: description: Response content: application/json: - schema: *268 + schema: *273 examples: - default: *269 + default: *274 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39673,7 +40428,7 @@ paths: url: https://docs.github.com/rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization parameters: - *90 - - *270 + - *275 responses: '204': description: Response @@ -39786,7 +40541,7 @@ paths: url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team parameters: - *90 - - *200 + - *203 - 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`). @@ -39818,13 +40573,13 @@ paths: application/json: schema: type: array - items: *271 + items: *276 examples: - default: *272 - '500': *91 + default: *277 + '500': *94 '403': *27 '404': *6 - '422': *273 + '422': *278 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39852,9 +40607,9 @@ paths: application/json: schema: type: array - items: *147 + items: *150 examples: - default: *204 + default: *207 headers: Link: *57 '403': *27 @@ -39948,7 +40703,7 @@ paths: description: Response content: application/json: - schema: &274 + schema: &279 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -40022,7 +40777,7 @@ paths: parent: anyOf: - type: 'null' - - *203 + - *206 members_count: type: integer examples: @@ -40328,7 +41083,7 @@ paths: - repos_count - organization examples: - default: &275 + default: &280 value: id: 1 node_id: MDQ6VGVhbTE= @@ -40399,15 +41154,15 @@ paths: url: https://docs.github.com/rest/teams/teams#get-a-team-by-name parameters: - *90 - - *200 + - *203 responses: '200': description: Response content: application/json: - schema: *274 + schema: *279 examples: - default: *275 + default: *280 '404': *6 x-github: githubCloudOnly: false @@ -40429,7 +41184,7 @@ paths: url: https://docs.github.com/rest/teams/teams#update-a-team parameters: - *90 - - *200 + - *203 requestBody: required: false content: @@ -40492,16 +41247,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *274 + schema: *279 examples: - default: *275 + default: *280 '201': description: Response content: application/json: - schema: *274 + schema: *279 examples: - default: *275 + default: *280 '404': *6 '422': *15 '403': *27 @@ -40527,7 +41282,7 @@ paths: url: https://docs.github.com/rest/teams/teams#delete-a-team parameters: - *90 - - *200 + - *203 responses: '204': description: Response @@ -40554,7 +41309,7 @@ paths: url: https://docs.github.com/rest/teams/discussions#list-discussions parameters: - *90 - - *200 + - *203 - *46 - *17 - *19 @@ -40571,7 +41326,7 @@ paths: application/json: schema: type: array - items: &276 + items: &281 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -40682,7 +41437,7 @@ paths: - updated_at - url examples: - default: &594 + default: &605 value: - author: login: octocat @@ -40757,7 +41512,7 @@ paths: url: https://docs.github.com/rest/teams/discussions#create-a-discussion parameters: - *90 - - *200 + - *203 requestBody: required: true content: @@ -40791,9 +41546,9 @@ paths: description: Response content: application/json: - schema: *276 + schema: *281 examples: - default: &277 + default: &282 value: author: login: octocat @@ -40866,8 +41621,8 @@ paths: url: https://docs.github.com/rest/teams/discussions#get-a-discussion parameters: - *90 - - *200 - - &278 + - *203 + - &283 name: discussion_number description: The number that identifies the discussion. in: path @@ -40879,9 +41634,9 @@ paths: description: Response content: application/json: - schema: *276 + schema: *281 examples: - default: *277 + default: *282 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40904,8 +41659,8 @@ paths: url: https://docs.github.com/rest/teams/discussions#update-a-discussion parameters: - *90 - - *200 - - *278 + - *203 + - *283 requestBody: required: false content: @@ -40928,9 +41683,9 @@ paths: description: Response content: application/json: - schema: *276 + schema: *281 examples: - default: &595 + default: &606 value: author: login: octocat @@ -41001,8 +41756,8 @@ paths: url: https://docs.github.com/rest/teams/discussions#delete-a-discussion parameters: - *90 - - *200 - - *278 + - *203 + - *283 responses: '204': description: Response @@ -41029,8 +41784,8 @@ paths: url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments parameters: - *90 - - *200 - - *278 + - *203 + - *283 - *46 - *17 - *19 @@ -41041,7 +41796,7 @@ paths: application/json: schema: type: array - items: &279 + items: &284 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -41121,7 +41876,7 @@ paths: - updated_at - url examples: - default: &596 + default: &607 value: - author: login: octocat @@ -41190,8 +41945,8 @@ paths: url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment parameters: - *90 - - *200 - - *278 + - *203 + - *283 requestBody: required: true content: @@ -41213,9 +41968,9 @@ paths: description: Response content: application/json: - schema: *279 + schema: *284 examples: - default: &280 + default: &285 value: author: login: octocat @@ -41282,9 +42037,9 @@ paths: url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment parameters: - *90 - - *200 - - *278 - - &281 + - *203 + - *283 + - &286 name: comment_number description: The number that identifies the comment. in: path @@ -41296,9 +42051,9 @@ paths: description: Response content: application/json: - schema: *279 + schema: *284 examples: - default: *280 + default: *285 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41321,9 +42076,9 @@ paths: url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment parameters: - *90 - - *200 - - *278 - - *281 + - *203 + - *283 + - *286 requestBody: required: true content: @@ -41345,9 +42100,9 @@ paths: description: Response content: application/json: - schema: *279 + schema: *284 examples: - default: &597 + default: &608 value: author: login: octocat @@ -41412,9 +42167,9 @@ paths: url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment parameters: - *90 - - *200 - - *278 - - *281 + - *203 + - *283 + - *286 responses: '204': description: Response @@ -41441,9 +42196,9 @@ paths: url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment parameters: - *90 - - *200 - - *278 - - *281 + - *203 + - *283 + - *286 - 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. @@ -41469,7 +42224,7 @@ paths: application/json: schema: type: array - items: &282 + items: &287 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -41513,7 +42268,7 @@ paths: - content - created_at examples: - default: &284 + default: &289 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -41564,9 +42319,9 @@ paths: url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment parameters: - *90 - - *200 - - *278 - - *281 + - *203 + - *283 + - *286 requestBody: required: true content: @@ -41599,9 +42354,9 @@ paths: team discussion comment content: application/json: - schema: *282 + schema: *287 examples: - default: &283 + default: &288 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -41630,9 +42385,9 @@ paths: description: Response content: application/json: - schema: *282 + schema: *287 examples: - default: *283 + default: *288 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41656,10 +42411,10 @@ paths: url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-comment-reaction parameters: - *90 - - *200 - - *278 - - *281 - - &285 + - *203 + - *283 + - *286 + - &290 name: reaction_id description: The unique identifier of the reaction. in: path @@ -41692,8 +42447,8 @@ paths: url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion parameters: - *90 - - *200 - - *278 + - *203 + - *283 - 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. @@ -41719,9 +42474,9 @@ paths: application/json: schema: type: array - items: *282 + items: *287 examples: - default: *284 + default: *289 headers: Link: *57 x-github: @@ -41748,8 +42503,8 @@ paths: url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion parameters: - *90 - - *200 - - *278 + - *203 + - *283 requestBody: required: true content: @@ -41781,16 +42536,16 @@ paths: description: Response content: application/json: - schema: *282 + schema: *287 examples: - default: *283 + default: *288 '201': description: Response content: application/json: - schema: *282 + schema: *287 examples: - default: *283 + default: *288 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -41814,9 +42569,9 @@ paths: url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-reaction parameters: - *90 - - *200 - - *278 - - *285 + - *203 + - *283 + - *290 responses: '204': description: Response @@ -41841,7 +42596,7 @@ paths: url: https://docs.github.com/rest/teams/members#list-pending-team-invitations parameters: - *90 - - *200 + - *203 - *17 - *19 responses: @@ -41851,9 +42606,9 @@ paths: application/json: schema: type: array - items: *183 + items: *186 examples: - default: *184 + default: *187 headers: Link: *57 x-github: @@ -41876,7 +42631,7 @@ paths: url: https://docs.github.com/rest/teams/members#list-team-members parameters: - *90 - - *200 + - *203 - name: role description: Filters members returned by their role in the team. in: query @@ -41899,7 +42654,7 @@ paths: type: array items: *4 examples: - default: *191 + default: *194 headers: Link: *57 x-github: @@ -41930,14 +42685,14 @@ paths: url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user parameters: - *90 - - *200 - - *129 + - *203 + - *132 responses: '200': description: Response content: application/json: - schema: &286 + schema: &291 title: Team Membership description: Team Membership type: object @@ -41965,7 +42720,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &598 + response-if-user-is-a-team-maintainer: &609 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -42002,8 +42757,8 @@ paths: url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user parameters: - *90 - - *200 - - *129 + - *203 + - *132 requestBody: required: false content: @@ -42028,9 +42783,9 @@ paths: description: Response content: application/json: - schema: *286 + schema: *291 examples: - response-if-users-membership-with-team-is-now-pending: &599 + response-if-users-membership-with-team-is-now-pending: &610 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -42066,8 +42821,8 @@ paths: url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user parameters: - *90 - - *200 - - *129 + - *203 + - *132 responses: '204': description: Response @@ -42093,7 +42848,7 @@ paths: url: https://docs.github.com/rest/teams/teams#list-team-projects parameters: - *90 - - *200 + - *203 - *17 - *19 responses: @@ -42103,7 +42858,7 @@ paths: application/json: schema: type: array - items: &287 + items: &292 title: Team Project description: A team's access to a project. type: object @@ -42172,7 +42927,7 @@ paths: - updated_at - permissions examples: - default: &600 + default: &611 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -42236,8 +42991,8 @@ paths: url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project parameters: - *90 - - *200 - - &288 + - *203 + - &293 name: project_id description: The unique identifier of the project. in: path @@ -42249,9 +43004,9 @@ paths: description: Response content: application/json: - schema: *287 + schema: *292 examples: - default: &601 + default: &612 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -42314,8 +43069,8 @@ paths: url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions parameters: - *90 - - *200 - - *288 + - *203 + - *293 requestBody: required: false content: @@ -42383,8 +43138,8 @@ paths: url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team parameters: - *90 - - *200 - - *288 + - *203 + - *293 responses: '204': description: Response @@ -42412,7 +43167,7 @@ paths: url: https://docs.github.com/rest/teams/teams#list-team-repositories parameters: - *90 - - *200 + - *203 - *17 - *19 responses: @@ -42422,9 +43177,9 @@ paths: application/json: schema: type: array - items: *116 + items: *119 examples: - default: *211 + default: *214 headers: Link: *57 x-github: @@ -42454,15 +43209,15 @@ paths: url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository parameters: - *90 - - *200 - - *289 - - *290 + - *203 + - *294 + - *295 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &602 + schema: &613 title: Team Repository description: A team's access to a repository. type: object @@ -43104,9 +43859,9 @@ paths: url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions parameters: - *90 - - *200 - - *289 - - *290 + - *203 + - *294 + - *295 requestBody: required: false content: @@ -43152,9 +43907,9 @@ paths: url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team parameters: - *90 - - *200 - - *289 - - *290 + - *203 + - *294 + - *295 responses: '204': description: Response @@ -43179,7 +43934,7 @@ paths: url: https://docs.github.com/rest/teams/teams#list-child-teams parameters: - *90 - - *200 + - *203 - *17 - *19 responses: @@ -43189,9 +43944,9 @@ paths: application/json: schema: type: array - items: *147 + items: *150 examples: - response-if-child-teams-exist: &603 + response-if-child-teams-exist: &614 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -43318,7 +44073,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/cards#get-a-project-card parameters: - - &291 + - &296 name: card_id description: The unique identifier of the card. in: path @@ -43330,7 +44085,7 @@ paths: description: Response content: application/json: - schema: &292 + schema: &297 title: Project Card description: Project cards represent a scope of work. type: object @@ -43405,7 +44160,7 @@ paths: - created_at - updated_at examples: - default: &293 + default: &298 value: url: https://api.github.com/projects/columns/cards/1478 id: 1478 @@ -43461,7 +44216,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/cards#update-an-existing-project-card parameters: - - *291 + - *296 requestBody: required: false content: @@ -43491,9 +44246,9 @@ paths: description: Response content: application/json: - schema: *292 + schema: *297 examples: - default: *293 + default: *298 '304': *35 '403': *27 '401': *23 @@ -43520,7 +44275,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/cards#delete-a-project-card parameters: - - *291 + - *296 responses: '204': description: Response @@ -43564,7 +44319,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/cards#move-a-project-card parameters: - - *291 + - *296 requestBody: required: true content: @@ -43677,7 +44432,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/columns#get-a-project-column parameters: - - &294 + - &299 name: column_id description: The unique identifier of the column. in: path @@ -43689,7 +44444,7 @@ paths: description: Response content: application/json: - schema: &295 + schema: &300 title: Project Column description: Project columns contain cards of work. type: object @@ -43743,7 +44498,7 @@ paths: - created_at - updated_at examples: - default: &296 + default: &301 value: url: https://api.github.com/projects/columns/367 project_url: https://api.github.com/projects/120 @@ -43778,7 +44533,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/columns#update-an-existing-project-column parameters: - - *294 + - *299 requestBody: required: true content: @@ -43803,9 +44558,9 @@ paths: description: Response content: application/json: - schema: *295 + schema: *300 examples: - default: *296 + default: *301 '304': *35 '403': *27 '401': *23 @@ -43830,7 +44585,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/columns#delete-a-project-column parameters: - - *294 + - *299 responses: '204': description: Response @@ -43859,7 +44614,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/cards#list-project-cards parameters: - - *294 + - *299 - name: archived_state description: Filters the project cards that are returned by the card's state. in: query @@ -43880,7 +44635,7 @@ paths: application/json: schema: type: array - items: *292 + items: *297 examples: default: value: @@ -43939,7 +44694,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/cards#create-a-project-card parameters: - - *294 + - *299 requestBody: required: true content: @@ -43983,9 +44738,9 @@ paths: description: Response content: application/json: - schema: *292 + schema: *297 examples: - default: *293 + default: *298 '304': *35 '403': *27 '401': *23 @@ -43995,8 +44750,8 @@ paths: application/json: schema: oneOf: - - *94 - - *95 + - *97 + - *98 '503': description: Response content: @@ -44041,7 +44796,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/columns#move-a-project-column parameters: - - *294 + - *299 requestBody: required: true content: @@ -44102,15 +44857,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#get-a-project parameters: - - *288 + - *293 responses: '200': description: Response content: application/json: - schema: *221 + schema: *224 examples: - default: &297 + default: &302 value: owner_url: https://api.github.com/repos/api-playground/projects-test url: https://api.github.com/projects/1002604 @@ -44167,7 +44922,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#update-a-project parameters: - - *288 + - *293 requestBody: required: false content: @@ -44216,9 +44971,9 @@ paths: description: Response content: application/json: - schema: *221 + schema: *224 examples: - default: *297 + default: *302 '404': description: Not Found if the authenticated user does not have access to the project @@ -44239,7 +44994,7 @@ paths: items: type: string '401': *23 - '410': *298 + '410': *303 '422': *7 x-github: githubCloudOnly: false @@ -44262,7 +45017,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#delete-a-project parameters: - - *288 + - *293 responses: '204': description: Delete Success @@ -44283,7 +45038,7 @@ paths: items: type: string '401': *23 - '410': *298 + '410': *303 '404': *6 x-github: githubCloudOnly: false @@ -44307,7 +45062,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/collaborators#list-project-collaborators parameters: - - *288 + - *293 - 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 @@ -44334,7 +45089,7 @@ paths: type: array items: *4 examples: - default: *191 + default: *194 headers: Link: *57 '404': *6 @@ -44364,8 +45119,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/collaborators#add-project-collaborator parameters: - - *288 - - *129 + - *293 + - *132 requestBody: required: false content: @@ -44419,8 +45174,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/collaborators#remove-user-as-a-collaborator parameters: - - *288 - - *129 + - *293 + - *132 responses: '204': description: Response @@ -44451,8 +45206,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/collaborators#get-project-permission-for-a-user parameters: - - *288 - - *129 + - *293 + - *132 responses: '200': description: Response @@ -44522,7 +45277,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/columns#list-project-columns parameters: - - *288 + - *293 - *17 - *19 responses: @@ -44532,7 +45287,7 @@ paths: application/json: schema: type: array - items: *295 + items: *300 examples: default: value: @@ -44570,7 +45325,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/columns#create-a-project-column parameters: - - *288 + - *293 requestBody: required: true content: @@ -44594,7 +45349,7 @@ paths: description: Response content: application/json: - schema: *295 + schema: *300 examples: default: value: @@ -44659,7 +45414,7 @@ paths: resources: type: object properties: - core: &299 + core: &304 title: Rate Limit type: object properties: @@ -44676,21 +45431,21 @@ paths: - remaining - reset - used - graphql: *299 - search: *299 - code_search: *299 - source_import: *299 - integration_manifest: *299 - code_scanning_upload: *299 - actions_runner_registration: *299 - scim: *299 - dependency_snapshots: *299 - dependency_sbom: *299 - code_scanning_autofix: *299 + graphql: *304 + search: *304 + code_search: *304 + source_import: *304 + integration_manifest: *304 + code_scanning_upload: *304 + actions_runner_registration: *304 + scim: *304 + dependency_snapshots: *304 + dependency_sbom: *304 + code_scanning_autofix: *304 required: - core - search - rate: *299 + rate: *304 required: - rate - resources @@ -44794,14 +45549,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: - - *289 - - *290 + - *294 + - *295 responses: '200': description: Response content: application/json: - schema: *300 + schema: *305 examples: default-response: summary: Default response @@ -45302,7 +46057,7 @@ paths: status: disabled '403': *27 '404': *6 - '301': *301 + '301': *306 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45320,8 +46075,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: false content: @@ -45569,10 +46324,10 @@ paths: description: Response content: application/json: - schema: *300 + schema: *305 examples: - default: *302 - '307': &303 + default: *307 + '307': &308 description: Temporary Redirect content: application/json: @@ -45601,8 +46356,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#delete-a-repository parameters: - - *289 - - *290 + - *294 + - *295 responses: '204': description: Response @@ -45624,7 +46379,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *303 + '307': *308 '404': *6 '409': *45 x-github: @@ -45648,11 +46403,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *289 - - *290 + - *294 + - *295 - *17 - *19 - - &329 + - &339 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -45675,7 +46430,7 @@ paths: type: integer artifacts: type: array - items: &304 + items: &309 title: Artifact description: An artifact type: object @@ -45770,7 +46525,7 @@ paths: - expires_at - updated_at examples: - default: &330 + default: &340 value: total_count: 2 artifacts: @@ -45831,9 +46586,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#get-an-artifact parameters: - - *289 - - *290 - - &305 + - *294 + - *295 + - &310 name: artifact_id description: The unique identifier of the artifact. in: path @@ -45845,7 +46600,7 @@ paths: description: Response content: application/json: - schema: *304 + schema: *309 examples: default: value: @@ -45883,9 +46638,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact parameters: - - *289 - - *290 - - *305 + - *294 + - *295 + - *310 responses: '204': description: Response @@ -45909,9 +46664,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#download-an-artifact parameters: - - *289 - - *290 - - *305 + - *294 + - *295 + - *310 - name: archive_format in: path required: true @@ -45925,7 +46680,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': *298 + '410': *303 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45948,14 +46703,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *289 - - *290 + - *294 + - *295 responses: '200': description: Response content: application/json: - schema: *306 + schema: *311 examples: default: value: @@ -45981,11 +46736,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *289 - - *290 + - *294 + - *295 - *17 - *19 - - &307 + - &312 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 @@ -46019,7 +46774,7 @@ paths: description: Response content: application/json: - schema: &308 + schema: &313 title: Repository actions caches description: Repository actions caches type: object @@ -46069,7 +46824,7 @@ paths: - total_count - actions_caches examples: - default: &309 + default: &314 value: total_count: 1 actions_caches: @@ -46101,23 +46856,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: - - *289 - - *290 + - *294 + - *295 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *307 + - *312 responses: '200': description: Response content: application/json: - schema: *308 + schema: *313 examples: - default: *309 + default: *314 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46137,8 +46892,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: - - *289 - - *290 + - *294 + - *295 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -46169,9 +46924,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *289 - - *290 - - &310 + - *294 + - *295 + - &315 name: job_id description: The unique identifier of the job. in: path @@ -46183,7 +46938,7 @@ paths: description: Response content: application/json: - schema: &333 + schema: &343 title: Job description: Information of a job execution in a workflow run type: object @@ -46530,9 +47285,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *289 - - *290 - - *310 + - *294 + - *295 + - *315 responses: '302': description: Response @@ -46560,9 +47315,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *289 - - *290 - - *310 + - *294 + - *295 + - *315 requestBody: required: false content: @@ -46584,7 +47339,7 @@ paths: description: Response content: application/json: - schema: *125 + schema: *128 examples: default: value: @@ -46608,8 +47363,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: - - *289 - - *290 + - *294 + - *295 responses: '200': description: Status response @@ -46659,8 +47414,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: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: @@ -46694,7 +47449,7 @@ paths: description: Empty response content: application/json: - schema: *125 + schema: *128 examples: default: value: @@ -46723,8 +47478,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets parameters: - - *289 - - *290 + - *294 + - *295 - *17 - *19 responses: @@ -46742,7 +47497,7 @@ paths: type: integer secrets: type: array - items: &335 + items: &345 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -46763,7 +47518,7 @@ paths: - created_at - updated_at examples: - default: &336 + default: &346 value: total_count: 2 secrets: @@ -46796,9 +47551,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables parameters: - - *289 - - *290 - - *311 + - *294 + - *295 + - *316 - *19 responses: '200': @@ -46815,7 +47570,7 @@ paths: type: integer variables: type: array - items: &339 + items: &349 title: Actions Variable type: object properties: @@ -46849,7 +47604,7 @@ paths: - created_at - updated_at examples: - default: &340 + default: &350 value: total_count: 2 variables: @@ -46882,8 +47637,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *289 - - *290 + - *294 + - *295 responses: '200': description: Response @@ -46892,11 +47647,11 @@ paths: schema: type: object properties: - enabled: &313 + enabled: &318 type: boolean description: Whether GitHub Actions is enabled on the repository. - allowed_actions: *105 - selected_actions_url: *312 + allowed_actions: *108 + selected_actions_url: *317 required: - enabled examples: @@ -46923,8 +47678,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *289 - - *290 + - *294 + - *295 responses: '204': description: Response @@ -46935,8 +47690,8 @@ paths: schema: type: object properties: - enabled: *313 - allowed_actions: *105 + enabled: *318 + allowed_actions: *108 required: - enabled examples: @@ -46965,14 +47720,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: - - *289 - - *290 + - *294 + - *295 responses: '200': description: Response content: application/json: - schema: &314 + schema: &319 type: object properties: access_level: @@ -46989,7 +47744,7 @@ paths: required: - access_level examples: - default: &315 + default: &320 value: access_level: organization x-github: @@ -47013,15 +47768,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: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: application/json: - schema: *314 + schema: *319 examples: - default: *315 + default: *320 responses: '204': description: Response @@ -47031,6 +47786,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: + - *294 + - *295 + responses: + '200': + description: Response + content: + application/json: + schema: *321 + 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: + - *294 + - *295 + responses: + '204': + description: Empty response for successful settings update + '404': *6 + '422': *15 + requestBody: + required: true + content: + application/json: + schema: *322 + 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: + - *294 + - *295 + responses: + '200': + description: Response + content: + application/json: + schema: *91 + examples: + default: *323 + '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: + - *294 + - *295 + responses: + '204': + description: Response + '404': *6 + '422': *15 + requestBody: + required: true + content: + application/json: + schema: *91 + examples: + default: + summary: Set approval policy to first time contributors + value: + approval_policy: first_time_contributors + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/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: + - *294 + - *295 + responses: + '200': + description: Response + content: + application/json: + schema: *324 + examples: + default: *92 + '403': *27 + '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: + - *294 + - *295 + requestBody: + required: true + content: + application/json: + schema: *325 + examples: + default: *92 + 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 @@ -47045,16 +47990,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *289 - - *290 + - *294 + - *295 responses: '200': description: Response content: application/json: - schema: *107 + schema: *110 examples: - default: *108 + default: *111 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -47073,8 +48018,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *289 - - *290 + - *294 + - *295 responses: '204': description: Response @@ -47082,9 +48027,9 @@ paths: required: false content: application/json: - schema: *107 + schema: *110 examples: - selected_actions: *108 + selected_actions: *111 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -47106,16 +48051,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *289 - - *290 + - *294 + - *295 responses: '200': description: Response content: application/json: - schema: *316 + schema: *326 examples: - default: *111 + default: *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47136,8 +48081,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *289 - - *290 + - *294 + - *295 responses: '204': description: Success response @@ -47148,9 +48093,9 @@ paths: required: true content: application/json: - schema: *317 + schema: *327 examples: - default: *111 + default: *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47177,8 +48122,8 @@ paths: in: query schema: type: string - - *289 - - *290 + - *294 + - *295 - *17 - *19 responses: @@ -47196,9 +48141,9 @@ paths: type: integer runners: type: array - items: *118 + items: *121 examples: - default: *119 + default: *122 headers: Link: *57 x-github: @@ -47222,8 +48167,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *289 - - *290 + - *294 + - *295 responses: '200': description: Response @@ -47231,9 +48176,9 @@ paths: application/json: schema: type: array - items: *318 + items: *328 examples: - default: *319 + default: *329 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47255,8 +48200,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: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: @@ -47299,7 +48244,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *320 + '201': *330 '404': *6 '422': *7 '409': *45 @@ -47330,16 +48275,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *289 - - *290 + - *294 + - *295 responses: '201': description: Response content: application/json: - schema: *120 + schema: *123 examples: - default: *321 + default: *331 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47367,16 +48312,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *289 - - *290 + - *294 + - *295 responses: '201': description: Response content: application/json: - schema: *120 + schema: *123 examples: - default: *322 + default: *332 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47398,17 +48343,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: - - *289 - - *290 - - *117 + - *294 + - *295 + - *120 responses: '200': description: Response content: application/json: - schema: *118 + schema: *121 examples: - default: *323 + default: *333 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47429,9 +48374,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: - - *289 - - *290 - - *117 + - *294 + - *295 + - *120 responses: '204': description: Response @@ -47457,11 +48402,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: - - *289 - - *290 - - *117 + - *294 + - *295 + - *120 responses: - '200': *122 + '200': *125 '404': *6 x-github: githubCloudOnly: false @@ -47483,9 +48428,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: - - *289 - - *290 - - *117 + - *294 + - *295 + - *120 requestBody: required: true content: @@ -47509,7 +48454,7 @@ paths: - gpu - accelerated responses: - '200': *122 + '200': *125 '404': *6 '422': *7 x-github: @@ -47533,9 +48478,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: - - *289 - - *290 - - *117 + - *294 + - *295 + - *120 requestBody: required: true content: @@ -47560,7 +48505,7 @@ paths: - gpu - accelerated responses: - '200': *122 + '200': *125 '404': *6 '422': *7 x-github: @@ -47584,11 +48529,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: - - *289 - - *290 - - *117 + - *294 + - *295 + - *120 responses: - '200': *324 + '200': *334 '404': *6 x-github: githubCloudOnly: false @@ -47615,12 +48560,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: - - *289 - - *290 - - *117 - - *325 + - *294 + - *295 + - *120 + - *335 responses: - '200': *122 + '200': *125 '404': *6 '422': *7 x-github: @@ -47646,9 +48591,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *289 - - *290 - - &343 + - *294 + - *295 + - &353 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. @@ -47656,7 +48601,7 @@ paths: required: false schema: type: string - - &344 + - &354 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -47664,7 +48609,7 @@ paths: required: false schema: type: string - - &345 + - &355 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -47673,7 +48618,7 @@ paths: required: false schema: type: string - - &346 + - &356 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 @@ -47700,7 +48645,7 @@ paths: - pending - *17 - *19 - - &347 + - &357 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)." @@ -47709,7 +48654,7 @@ paths: schema: type: string format: date-time - - &326 + - &336 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -47718,13 +48663,13 @@ paths: schema: type: boolean default: false - - &348 + - &358 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &349 + - &359 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -47747,7 +48692,7 @@ paths: type: integer workflow_runs: type: array - items: &327 + items: &337 title: Workflow Run description: An invocation of a workflow type: object @@ -47864,7 +48809,7 @@ paths: type: - array - 'null' - items: &368 + items: &378 title: Pull Request Minimal type: object properties: @@ -47991,7 +48936,7 @@ paths: head_commit: anyOf: - type: 'null' - - &372 + - &382 title: Simple Commit description: A commit. type: object @@ -48065,8 +49010,8 @@ paths: - timestamp - author - committer - repository: *116 - head_repository: *116 + repository: *119 + head_repository: *119 head_repository_id: type: integer examples: @@ -48106,7 +49051,7 @@ paths: - workflow_url - pull_requests examples: - default: &350 + default: &360 value: total_count: 1 workflow_runs: @@ -48342,24 +49287,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run parameters: - - *289 - - *290 - - &328 + - *294 + - *295 + - &338 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *326 + - *336 responses: '200': description: Response content: application/json: - schema: *327 + schema: *337 examples: - default: &331 + default: &341 value: id: 30433642 name: Build @@ -48600,9 +49545,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *289 - - *290 - - *328 + - *294 + - *295 + - *338 responses: '204': description: Response @@ -48625,9 +49570,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *289 - - *290 - - *328 + - *294 + - *295 + - *338 responses: '200': description: Response @@ -48755,15 +49700,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: - - *289 - - *290 - - *328 + - *294 + - *295 + - *338 responses: '201': description: Response content: application/json: - schema: *125 + schema: *128 examples: default: value: @@ -48790,12 +49735,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *289 - - *290 - - *328 + - *294 + - *295 + - *338 - *17 - *19 - - *329 + - *339 responses: '200': description: Response @@ -48811,9 +49756,9 @@ paths: type: integer artifacts: type: array - items: *304 + items: *309 examples: - default: *330 + default: *340 headers: Link: *57 x-github: @@ -48837,25 +49782,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *289 - - *290 - - *328 - - &332 + - *294 + - *295 + - *338 + - &342 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *326 + - *336 responses: '200': description: Response content: application/json: - schema: *327 + schema: *337 examples: - default: *331 + default: *341 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48878,10 +49823,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *289 - - *290 - - *328 - - *332 + - *294 + - *295 + - *338 + - *342 - *17 - *19 responses: @@ -48899,9 +49844,9 @@ paths: type: integer jobs: type: array - items: *333 + items: *343 examples: - default: &334 + default: &344 value: total_count: 1 jobs: @@ -49014,10 +49959,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *289 - - *290 - - *328 - - *332 + - *294 + - *295 + - *338 + - *342 responses: '302': description: Response @@ -49045,15 +49990,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *289 - - *290 - - *328 + - *294 + - *295 + - *338 responses: '202': description: Response content: application/json: - schema: *125 + schema: *128 examples: default: value: @@ -49080,9 +50025,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: - - *289 - - *290 - - *328 + - *294 + - *295 + - *338 requestBody: required: true content: @@ -49149,15 +50094,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *289 - - *290 - - *328 + - *294 + - *295 + - *338 responses: '202': description: Response content: application/json: - schema: *125 + schema: *128 examples: default: value: @@ -49184,9 +50129,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *289 - - *290 - - *328 + - *294 + - *295 + - *338 - 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 @@ -49216,9 +50161,9 @@ paths: type: integer jobs: type: array - items: *333 + items: *343 examples: - default: *334 + default: *344 headers: Link: *57 x-github: @@ -49243,9 +50188,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *289 - - *290 - - *328 + - *294 + - *295 + - *338 responses: '302': description: Response @@ -49272,14 +50217,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *289 - - *290 - - *328 + - *294 + - *295 + - *338 responses: '204': description: Response '403': *27 - '500': *91 + '500': *94 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49301,9 +50246,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *289 - - *290 - - *328 + - *294 + - *295 + - *338 responses: '200': description: Response @@ -49372,7 +50317,7 @@ paths: items: type: object properties: - type: &446 + type: &456 type: string description: The type of reviewer. enum: @@ -49383,7 +50328,7 @@ paths: reviewer: anyOf: - *4 - - *147 + - *150 required: - environment - wait_timer @@ -49458,9 +50403,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *289 - - *290 - - *328 + - *294 + - *295 + - *338 requestBody: required: true content: @@ -49510,7 +50455,7 @@ paths: application/json: schema: type: array - items: &441 + items: &451 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -49622,7 +50567,7 @@ paths: - created_at - updated_at examples: - default: &442 + default: &452 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -49678,9 +50623,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow parameters: - - *289 - - *290 - - *328 + - *294 + - *295 + - *338 requestBody: required: false content: @@ -49702,7 +50647,7 @@ paths: description: Response content: application/json: - schema: *125 + schema: *128 examples: default: value: @@ -49725,9 +50670,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *289 - - *290 - - *328 + - *294 + - *295 + - *338 requestBody: required: false content: @@ -49749,7 +50694,7 @@ paths: description: Response content: application/json: - schema: *125 + schema: *128 examples: default: value: @@ -49781,9 +50726,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *289 - - *290 - - *328 + - *294 + - *295 + - *338 responses: '200': description: Response @@ -49920,8 +50865,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-secrets parameters: - - *289 - - *290 + - *294 + - *295 - *17 - *19 responses: @@ -49939,9 +50884,9 @@ paths: type: integer secrets: type: array - items: *335 + items: *345 examples: - default: *336 + default: *346 headers: Link: *57 x-github: @@ -49966,16 +50911,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key parameters: - - *289 - - *290 + - *294 + - *295 responses: '200': description: Response content: application/json: - schema: *337 + schema: *347 examples: - default: *338 + default: *348 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49997,17 +50942,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret parameters: - - *289 - - *290 - - *124 + - *294 + - *295 + - *127 responses: '200': description: Response content: application/json: - schema: *335 + schema: *345 examples: - default: &459 + default: &469 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -50033,9 +50978,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *289 - - *290 - - *124 + - *294 + - *295 + - *127 requestBody: required: true content: @@ -50066,7 +51011,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *125 + schema: *128 examples: default: value: @@ -50092,9 +51037,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret parameters: - - *289 - - *290 - - *124 + - *294 + - *295 + - *127 responses: '204': description: Response @@ -50119,9 +51064,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-variables parameters: - - *289 - - *290 - - *311 + - *294 + - *295 + - *316 - *19 responses: '200': @@ -50138,9 +51083,9 @@ paths: type: integer variables: type: array - items: *339 + items: *349 examples: - default: *340 + default: *350 headers: Link: *57 x-github: @@ -50163,8 +51108,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-a-repository-variable parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: @@ -50191,7 +51136,7 @@ paths: description: Response content: application/json: - schema: *125 + schema: *128 examples: default: value: @@ -50216,17 +51161,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-a-repository-variable parameters: - - *289 - - *290 - - *127 + - *294 + - *295 + - *130 responses: '200': description: Response content: application/json: - schema: *339 + schema: *349 examples: - default: &460 + default: &470 value: name: USERNAME value: octocat @@ -50252,9 +51197,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-a-repository-variable parameters: - - *289 - - *290 - - *127 + - *294 + - *295 + - *130 requestBody: required: true content: @@ -50296,9 +51241,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable parameters: - - *289 - - *290 - - *127 + - *294 + - *295 + - *130 responses: '204': description: Response @@ -50323,8 +51268,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#list-repository-workflows parameters: - - *289 - - *290 + - *294 + - *295 - *17 - *19 responses: @@ -50342,7 +51287,7 @@ paths: type: integer workflows: type: array - items: &341 + items: &351 title: Workflow description: A GitHub Actions workflow type: object @@ -50460,9 +51405,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-a-workflow parameters: - - *289 - - *290 - - &342 + - *294 + - *295 + - &352 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -50477,7 +51422,7 @@ paths: description: Response content: application/json: - schema: *341 + schema: *351 examples: default: value: @@ -50510,9 +51455,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#disable-a-workflow parameters: - - *289 - - *290 - - *342 + - *294 + - *295 + - *352 responses: '204': description: Response @@ -50537,9 +51482,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *289 - - *290 - - *342 + - *294 + - *295 + - *352 responses: '204': description: Response @@ -50590,9 +51535,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#enable-a-workflow parameters: - - *289 - - *290 - - *342 + - *294 + - *295 + - *352 responses: '204': description: Response @@ -50619,19 +51564,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *289 - - *290 - - *342 - - *343 - - *344 - - *345 - - *346 + - *294 + - *295 + - *352 + - *353 + - *354 + - *355 + - *356 - *17 - *19 - - *347 - - *326 - - *348 - - *349 + - *357 + - *336 + - *358 + - *359 responses: '200': description: Response @@ -50647,9 +51592,9 @@ paths: type: integer workflow_runs: type: array - items: *327 + items: *337 examples: - default: *350 + default: *360 headers: Link: *57 x-github: @@ -50681,9 +51626,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-workflow-usage parameters: - - *289 - - *290 - - *342 + - *294 + - *295 + - *352 responses: '200': description: Response @@ -50744,8 +51689,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-activities parameters: - - *289 - - *290 + - *294 + - *295 - *46 - *17 - *38 @@ -50913,8 +51858,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#list-assignees parameters: - - *289 - - *290 + - *294 + - *295 - *17 - *19 responses: @@ -50926,7 +51871,7 @@ paths: type: array items: *4 examples: - default: *191 + default: *194 headers: Link: *57 '404': *6 @@ -50951,8 +51896,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *289 - - *290 + - *294 + - *295 - name: assignee in: path required: true @@ -50988,8 +51933,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-an-attestation parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: @@ -51101,8 +52046,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-attestations parameters: - - *289 - - *290 + - *294 + - *295 - *17 - *38 - *39 @@ -51156,7 +52101,7 @@ paths: bundle_url: type: string examples: - default: *351 + default: *361 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51176,8 +52121,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *289 - - *290 + - *294 + - *295 responses: '200': description: Response @@ -51185,7 +52130,7 @@ paths: application/json: schema: type: array - items: &352 + items: &362 title: Autolink reference description: An autolink reference. type: object @@ -51239,8 +52184,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: @@ -51279,9 +52224,9 @@ paths: description: response content: application/json: - schema: *352 + schema: *362 examples: - default: &353 + default: &363 value: id: 1 key_prefix: TICKET- @@ -51312,9 +52257,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *289 - - *290 - - &354 + - *294 + - *295 + - &364 name: autolink_id description: The unique identifier of the autolink. in: path @@ -51326,9 +52271,9 @@ paths: description: Response content: application/json: - schema: *352 + schema: *362 examples: - default: *353 + default: *363 '404': *6 x-github: githubCloudOnly: false @@ -51348,9 +52293,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *289 - - *290 - - *354 + - *294 + - *295 + - *364 responses: '204': description: Response @@ -51374,8 +52319,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: - - *289 - - *290 + - *294 + - *295 responses: '200': description: Response if Dependabot is enabled @@ -51425,8 +52370,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates parameters: - - *289 - - *290 + - *294 + - *295 responses: '204': description: Response @@ -51447,8 +52392,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates parameters: - - *289 - - *290 + - *294 + - *295 responses: '204': description: Response @@ -51468,8 +52413,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#list-branches parameters: - - *289 - - *290 + - *294 + - *295 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -51507,7 +52452,7 @@ paths: - url protected: type: boolean - protection: &356 + protection: &366 title: Branch Protection description: Branch Protection type: object @@ -51550,7 +52495,7 @@ paths: required: - contexts - checks - enforce_admins: &359 + enforce_admins: &369 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -51567,7 +52512,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &361 + required_pull_request_reviews: &371 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -51589,7 +52534,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *147 + items: *150 apps: description: The list of apps with review dismissal access. @@ -51621,7 +52566,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *147 + items: *150 apps: description: The list of apps allowed to bypass pull request requirements. @@ -51651,7 +52596,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &358 + restrictions: &368 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -51976,9 +52921,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#get-a-branch parameters: - - *289 - - *290 - - &357 + - *294 + - *295 + - &367 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). @@ -51992,14 +52937,14 @@ paths: description: Response content: application/json: - schema: &367 + schema: &377 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &417 + commit: &427 title: Commit description: Commit type: object @@ -52038,7 +52983,7 @@ paths: author: anyOf: - type: 'null' - - &355 + - &365 title: Git User description: Metaproperties for Git author/committer information. @@ -52059,7 +53004,7 @@ paths: committer: anyOf: - type: 'null' - - *355 + - *365 message: type: string examples: @@ -52083,7 +53028,7 @@ paths: required: - sha - url - verification: &466 + verification: &476 title: Verification type: object properties: @@ -52119,14 +53064,14 @@ paths: author: oneOf: - *4 - - *125 + - *128 type: - 'null' - object committer: oneOf: - *4 - - *125 + - *128 type: - 'null' - object @@ -52163,7 +53108,7 @@ paths: type: integer files: type: array - items: &429 + items: &439 title: Diff Entry description: Diff Entry type: object @@ -52257,7 +53202,7 @@ paths: - self protected: type: boolean - protection: *356 + protection: *366 protection_url: type: string format: uri @@ -52366,7 +53311,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *301 + '301': *306 '404': *6 x-github: githubCloudOnly: false @@ -52388,15 +53333,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection parameters: - - *289 - - *290 - - *357 + - *294 + - *295 + - *367 responses: '200': description: Response content: application/json: - schema: *356 + schema: *366 examples: default: value: @@ -52590,9 +53535,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection parameters: - - *289 - - *290 - - *357 + - *294 + - *295 + - *367 requestBody: required: true content: @@ -52852,7 +53797,7 @@ paths: url: type: string format: uri - required_status_checks: &364 + required_status_checks: &374 title: Status Check Policy description: Status Check Policy type: object @@ -52933,7 +53878,7 @@ paths: items: *4 teams: type: array - items: *147 + items: *150 apps: type: array items: *5 @@ -52951,7 +53896,7 @@ paths: items: *4 teams: type: array - items: *147 + items: *150 apps: type: array items: *5 @@ -53011,7 +53956,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *358 + restrictions: *368 required_conversation_resolution: type: object properties: @@ -53123,9 +54068,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection parameters: - - *289 - - *290 - - *357 + - *294 + - *295 + - *367 responses: '204': description: Response @@ -53150,17 +54095,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection parameters: - - *289 - - *290 - - *357 + - *294 + - *295 + - *367 responses: '200': description: Response content: application/json: - schema: *359 + schema: *369 examples: - default: &360 + default: &370 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -53182,17 +54127,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection parameters: - - *289 - - *290 - - *357 + - *294 + - *295 + - *367 responses: '200': description: Response content: application/json: - schema: *359 + schema: *369 examples: - default: *360 + default: *370 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53211,9 +54156,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *289 - - *290 - - *357 + - *294 + - *295 + - *367 responses: '204': description: Response @@ -53238,17 +54183,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *289 - - *290 - - *357 + - *294 + - *295 + - *367 responses: '200': description: Response content: application/json: - schema: *361 + schema: *371 examples: - default: &362 + default: &372 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -53344,9 +54289,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *289 - - *290 - - *357 + - *294 + - *295 + - *367 requestBody: required: false content: @@ -53444,9 +54389,9 @@ paths: description: Response content: application/json: - schema: *361 + schema: *371 examples: - default: *362 + default: *372 '422': *15 x-github: githubCloudOnly: false @@ -53467,9 +54412,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *289 - - *290 - - *357 + - *294 + - *295 + - *367 responses: '204': description: Response @@ -53496,17 +54441,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection parameters: - - *289 - - *290 - - *357 + - *294 + - *295 + - *367 responses: '200': description: Response content: application/json: - schema: *359 + schema: *369 examples: - default: &363 + default: &373 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -53529,17 +54474,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection parameters: - - *289 - - *290 - - *357 + - *294 + - *295 + - *367 responses: '200': description: Response content: application/json: - schema: *359 + schema: *369 examples: - default: *363 + default: *373 '404': *6 x-github: githubCloudOnly: false @@ -53559,9 +54504,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *289 - - *290 - - *357 + - *294 + - *295 + - *367 responses: '204': description: Response @@ -53586,17 +54531,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection parameters: - - *289 - - *290 - - *357 + - *294 + - *295 + - *367 responses: '200': description: Response content: application/json: - schema: *364 + schema: *374 examples: - default: &365 + default: &375 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -53622,9 +54567,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection parameters: - - *289 - - *290 - - *357 + - *294 + - *295 + - *367 requestBody: required: false content: @@ -53676,9 +54621,9 @@ paths: description: Response content: application/json: - schema: *364 + schema: *374 examples: - default: *365 + default: *375 '404': *6 '422': *15 x-github: @@ -53700,9 +54645,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection parameters: - - *289 - - *290 - - *357 + - *294 + - *295 + - *367 responses: '204': description: Response @@ -53726,9 +54671,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *289 - - *290 - - *357 + - *294 + - *295 + - *367 responses: '200': description: Response @@ -53762,9 +54707,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts parameters: - - *289 - - *290 - - *357 + - *294 + - *295 + - *367 requestBody: required: false content: @@ -53831,9 +54776,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts parameters: - - *289 - - *290 - - *357 + - *294 + - *295 + - *367 requestBody: required: false content: @@ -53897,9 +54842,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts parameters: - - *289 - - *290 - - *357 + - *294 + - *295 + - *367 requestBody: content: application/json: @@ -53965,15 +54910,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions parameters: - - *289 - - *290 - - *357 + - *294 + - *295 + - *367 responses: '200': description: Response content: application/json: - schema: *358 + schema: *368 examples: default: value: @@ -54064,9 +55009,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions parameters: - - *289 - - *290 - - *357 + - *294 + - *295 + - *367 responses: '204': description: Response @@ -54089,9 +55034,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *289 - - *290 - - *357 + - *294 + - *295 + - *367 responses: '200': description: Response @@ -54101,7 +55046,7 @@ paths: type: array items: *5 examples: - default: &366 + default: &376 value: - id: 1 slug: octoapp @@ -54158,9 +55103,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions parameters: - - *289 - - *290 - - *357 + - *294 + - *295 + - *367 requestBody: required: true content: @@ -54194,7 +55139,7 @@ paths: type: array items: *5 examples: - default: *366 + default: *376 '422': *15 x-github: githubCloudOnly: false @@ -54215,9 +55160,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions parameters: - - *289 - - *290 - - *357 + - *294 + - *295 + - *367 requestBody: required: true content: @@ -54251,7 +55196,7 @@ paths: type: array items: *5 examples: - default: *366 + default: *376 '422': *15 x-github: githubCloudOnly: false @@ -54272,9 +55217,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *289 - - *290 - - *357 + - *294 + - *295 + - *367 requestBody: required: true content: @@ -54308,7 +55253,7 @@ paths: type: array items: *5 examples: - default: *366 + default: *376 '422': *15 x-github: githubCloudOnly: false @@ -54330,9 +55275,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *289 - - *290 - - *357 + - *294 + - *295 + - *367 responses: '200': description: Response @@ -54340,9 +55285,9 @@ paths: application/json: schema: type: array - items: *147 + items: *150 examples: - default: *204 + default: *207 '404': *6 x-github: githubCloudOnly: false @@ -54362,9 +55307,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions parameters: - - *289 - - *290 - - *357 + - *294 + - *295 + - *367 requestBody: required: false content: @@ -54400,9 +55345,9 @@ paths: application/json: schema: type: array - items: *147 + items: *150 examples: - default: *204 + default: *207 '422': *15 x-github: githubCloudOnly: false @@ -54423,9 +55368,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions parameters: - - *289 - - *290 - - *357 + - *294 + - *295 + - *367 requestBody: required: false content: @@ -54461,9 +55406,9 @@ paths: application/json: schema: type: array - items: *147 + items: *150 examples: - default: *204 + default: *207 '422': *15 x-github: githubCloudOnly: false @@ -54484,9 +55429,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *289 - - *290 - - *357 + - *294 + - *295 + - *367 requestBody: content: application/json: @@ -54521,9 +55466,9 @@ paths: application/json: schema: type: array - items: *147 + items: *150 examples: - default: *204 + default: *207 '422': *15 x-github: githubCloudOnly: false @@ -54545,9 +55490,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *289 - - *290 - - *357 + - *294 + - *295 + - *367 responses: '200': description: Response @@ -54557,7 +55502,7 @@ paths: type: array items: *4 examples: - default: *191 + default: *194 '404': *6 x-github: githubCloudOnly: false @@ -54581,9 +55526,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions parameters: - - *289 - - *290 - - *357 + - *294 + - *295 + - *367 requestBody: required: true content: @@ -54616,7 +55561,7 @@ paths: type: array items: *4 examples: - default: *191 + default: *194 '422': *15 x-github: githubCloudOnly: false @@ -54641,9 +55586,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions parameters: - - *289 - - *290 - - *357 + - *294 + - *295 + - *367 requestBody: required: true content: @@ -54676,7 +55621,7 @@ paths: type: array items: *4 examples: - default: *191 + default: *194 '422': *15 x-github: githubCloudOnly: false @@ -54701,9 +55646,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *289 - - *290 - - *357 + - *294 + - *295 + - *367 requestBody: required: true content: @@ -54736,7 +55681,7 @@ paths: type: array items: *4 examples: - default: *191 + default: *194 '422': *15 x-github: githubCloudOnly: false @@ -54763,9 +55708,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#rename-a-branch parameters: - - *289 - - *290 - - *357 + - *294 + - *295 + - *367 requestBody: required: true content: @@ -54787,7 +55732,7 @@ paths: description: Response content: application/json: - schema: *367 + schema: *377 examples: default: value: @@ -54903,8 +55848,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#create-a-check-run parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: @@ -55183,7 +56128,7 @@ paths: description: Response content: application/json: - schema: &369 + schema: &379 title: CheckRun description: A check performed on the code of a given code change type: object @@ -55318,8 +56263,8 @@ paths: do not necessarily indicate pull requests that triggered the check. type: array - items: *368 - deployment: &659 + items: *378 + deployment: &669 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -55606,9 +56551,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#get-a-check-run parameters: - - *289 - - *290 - - &370 + - *294 + - *295 + - &380 name: check_run_id description: The unique identifier of the check run. in: path @@ -55620,9 +56565,9 @@ paths: description: Response content: application/json: - schema: *369 + schema: *379 examples: - default: &371 + default: &381 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -55722,9 +56667,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#update-a-check-run parameters: - - *289 - - *290 - - *370 + - *294 + - *295 + - *380 requestBody: required: true content: @@ -55964,9 +56909,9 @@ paths: description: Response content: application/json: - schema: *369 + schema: *379 examples: - default: *371 + default: *381 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55986,9 +56931,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-run-annotations parameters: - - *289 - - *290 - - *370 + - *294 + - *295 + - *380 - *17 - *19 responses: @@ -56098,15 +57043,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run parameters: - - *289 - - *290 - - *370 + - *294 + - *295 + - *380 responses: '201': description: Response content: application/json: - schema: *125 + schema: *128 examples: default: value: @@ -56144,8 +57089,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#create-a-check-suite parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: @@ -56167,7 +57112,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &373 + schema: &383 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -56249,12 +57194,12 @@ paths: type: - array - 'null' - items: *368 + items: *378 app: anyOf: - type: 'null' - *5 - repository: *116 + repository: *119 created_at: type: - string @@ -56265,7 +57210,7 @@ paths: - string - 'null' format: date-time - head_commit: *372 + head_commit: *382 latest_check_runs_count: type: integer check_runs_url: @@ -56293,7 +57238,7 @@ paths: - check_runs_url - pull_requests examples: - default: &374 + default: &384 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -56584,9 +57529,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *373 + schema: *383 examples: - default: *374 + default: *384 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56605,8 +57550,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: @@ -56667,7 +57612,7 @@ paths: required: - app_id - setting - repository: *116 + repository: *119 examples: default: value: @@ -56915,9 +57860,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#get-a-check-suite parameters: - - *289 - - *290 - - &375 + - *294 + - *295 + - &385 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -56929,9 +57874,9 @@ paths: description: Response content: application/json: - schema: *373 + schema: *383 examples: - default: *374 + default: *384 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56954,17 +57899,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *289 - - *290 - - *375 - - &424 + - *294 + - *295 + - *385 + - &434 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &425 + - &435 name: status description: Returns check runs with the specified `status`. in: query @@ -57003,9 +57948,9 @@ paths: type: integer check_runs: type: array - items: *369 + items: *379 examples: - default: &426 + default: &436 value: total_count: 1 check_runs: @@ -57107,15 +58052,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite parameters: - - *289 - - *290 - - *375 + - *294 + - *295 + - *385 responses: '201': description: Response content: application/json: - schema: *125 + schema: *128 examples: default: value: @@ -57142,21 +58087,21 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *289 - - *290 - - *376 - - *377 + - *294 + - *295 + - *386 + - *387 - *19 - *17 - - &394 + - &404 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: *378 - - &395 + schema: *388 + - &405 name: pr description: The number of the pull request for the results you want to list. in: query @@ -57181,13 +58126,13 @@ paths: be returned. in: query required: false - schema: *379 + schema: *389 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *380 + schema: *390 responses: '200': description: Response @@ -57203,19 +58148,19 @@ paths: updated_at: *54 url: *55 html_url: *56 - instances_url: *381 - state: *137 - fixed_at: *133 + instances_url: *391 + state: *140 + fixed_at: *136 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *134 - dismissed_reason: *382 - dismissed_comment: *383 - rule: *384 - tool: *385 - most_recent_instance: *386 + dismissed_at: *137 + dismissed_reason: *392 + dismissed_comment: *393 + rule: *394 + tool: *395 + most_recent_instance: *396 dismissal_approved_by: anyOf: - type: 'null' @@ -57335,7 +58280,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *35 - '403': &387 + '403': &397 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -57362,9 +58307,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *289 - - *290 - - &388 + - *294 + - *295 + - &398 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -57378,7 +58323,7 @@ paths: description: Response content: application/json: - schema: &389 + schema: &399 type: object properties: number: *52 @@ -57386,16 +58331,16 @@ paths: updated_at: *54 url: *55 html_url: *56 - instances_url: *381 - state: *137 - fixed_at: *133 + instances_url: *391 + state: *140 + fixed_at: *136 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *134 - dismissed_reason: *382 - dismissed_comment: *383 + dismissed_at: *137 + dismissed_reason: *392 + dismissed_comment: *393 rule: type: object properties: @@ -57457,8 +58402,8 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: *385 - most_recent_instance: *386 + tool: *395 + most_recent_instance: *396 dismissal_approved_by: anyOf: - type: 'null' @@ -57551,7 +58496,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *35 - '403': *387 + '403': *397 '404': *6 '503': *62 x-github: @@ -57571,9 +58516,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *289 - - *290 - - *388 + - *294 + - *295 + - *398 requestBody: required: true content: @@ -57588,8 +58533,8 @@ paths: enum: - open - dismissed - dismissed_reason: *382 - dismissed_comment: *383 + dismissed_reason: *392 + dismissed_comment: *393 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -57608,7 +58553,7 @@ paths: description: Response content: application/json: - schema: *389 + schema: *399 examples: default: value: @@ -57684,7 +58629,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &393 + '403': &403 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -57711,15 +58656,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: - - *289 - - *290 - - *388 + - *294 + - *295 + - *398 responses: '200': description: Response content: application/json: - schema: &390 + schema: &400 type: object properties: status: @@ -57746,13 +58691,13 @@ paths: - description - started_at examples: - default: &391 + default: &401 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &392 + '400': &402 description: Bad Request content: application/json: @@ -57763,7 +58708,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': *387 + '403': *397 '404': *6 '503': *62 x-github: @@ -57788,29 +58733,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: - - *289 - - *290 - - *388 + - *294 + - *295 + - *398 responses: '200': description: OK content: application/json: - schema: *390 + schema: *400 examples: - default: *391 + default: *401 '202': description: Accepted content: application/json: - schema: *390 + schema: *400 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *392 + '400': *402 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -57842,9 +58787,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: - - *289 - - *290 - - *388 + - *294 + - *295 + - *398 requestBody: required: false content: @@ -57890,8 +58835,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *392 - '403': *393 + '400': *402 + '403': *403 '404': *6 '422': description: Unprocessable Entity @@ -57915,13 +58860,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *289 - - *290 - - *388 + - *294 + - *295 + - *398 - *19 - *17 - - *394 - - *395 + - *404 + - *405 responses: '200': description: Response @@ -57929,7 +58874,7 @@ paths: application/json: schema: type: array - items: *386 + items: *396 examples: default: value: @@ -57968,7 +58913,7 @@ paths: end_column: 50 classifications: - source - '403': *387 + '403': *397 '404': *6 '503': *62 x-github: @@ -58002,25 +58947,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *289 - - *290 - - *376 - - *377 + - *294 + - *295 + - *386 + - *387 - *19 - *17 - - *395 + - *405 - 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: *378 + schema: *388 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &398 + schema: &408 type: string description: An identifier for the upload. examples: @@ -58042,23 +58987,23 @@ paths: application/json: schema: type: array - items: &399 + items: &409 type: object properties: - ref: *378 - commit_sha: &407 + ref: *388 + commit_sha: &417 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: *396 + analysis_key: *406 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *397 + category: *407 error: type: string examples: @@ -58083,8 +59028,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *398 - tool: *385 + sarif_id: *408 + tool: *395 deletable: type: boolean warning: @@ -58146,7 +59091,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *387 + '403': *397 '404': *6 '503': *62 x-github: @@ -58182,8 +59127,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: - - *289 - - *290 + - *294 + - *295 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -58196,7 +59141,7 @@ paths: description: Response content: application/json: - schema: *399 + schema: *409 examples: response: summary: application/json response @@ -58250,7 +59195,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *387 + '403': *397 '404': *6 '422': description: Response if analysis could not be processed @@ -58337,8 +59282,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: - - *289 - - *290 + - *294 + - *295 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -58394,7 +59339,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': *393 + '403': *403 '404': *6 '503': *62 x-github: @@ -58416,8 +59361,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *289 - - *290 + - *294 + - *295 responses: '200': description: Response @@ -58425,7 +59370,7 @@ paths: application/json: schema: type: array - items: &400 + items: &410 title: CodeQL Database description: A CodeQL database. type: object @@ -58537,7 +59482,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': *387 + '403': *397 '404': *6 '503': *62 x-github: @@ -58566,8 +59511,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *289 - - *290 + - *294 + - *295 - name: language in: path description: The language of the CodeQL database. @@ -58579,7 +59524,7 @@ paths: description: Response content: application/json: - schema: *400 + schema: *410 examples: default: value: @@ -58611,9 +59556,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': &431 + '302': &441 description: Found - '403': *387 + '403': *397 '404': *6 '503': *62 x-github: @@ -58635,8 +59580,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *289 - - *290 + - *294 + - *295 - name: language in: path description: The language of the CodeQL database. @@ -58646,7 +59591,7 @@ paths: responses: '204': description: Response - '403': *393 + '403': *403 '404': *6 '503': *62 x-github: @@ -58674,8 +59619,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: @@ -58684,7 +59629,7 @@ paths: type: object additionalProperties: false properties: - language: &401 + language: &411 type: string description: The language targeted by the CodeQL query enum: @@ -58763,7 +59708,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &405 + schema: &415 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -58773,7 +59718,7 @@ paths: description: The ID of the variant analysis. controller_repo: *51 actor: *4 - query_language: *401 + query_language: *411 query_pack_url: type: string description: The download url for the query pack. @@ -58821,7 +59766,7 @@ paths: items: type: object properties: - repository: &402 + repository: &412 title: Repository Identifier description: Repository Identifier type: object @@ -58863,7 +59808,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &406 + analysis_status: &416 type: string description: The new status of the CodeQL variant analysis repository task. @@ -58895,7 +59840,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &403 + access_mismatch_repos: &413 type: object properties: repository_count: @@ -58910,7 +59855,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: *402 + items: *412 required: - repository_count - repositories @@ -58933,8 +59878,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *403 - over_limit_repos: *403 + no_codeql_db_repos: *413 + over_limit_repos: *413 required: - access_mismatch_repos - not_found_repos @@ -58950,7 +59895,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &404 + value: &414 summary: Default response value: id: 1 @@ -59102,10 +60047,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *404 + value: *414 repository_lists: summary: Response for a successful variant analysis submission - value: *404 + value: *414 '404': *6 '422': description: Unable to process variant analysis submission @@ -59133,8 +60078,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: - - *289 - - *290 + - *294 + - *295 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -59146,9 +60091,9 @@ paths: description: Response content: application/json: - schema: *405 + schema: *415 examples: - default: *404 + default: *414 '404': *6 '503': *62 x-github: @@ -59171,7 +60116,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: - - *289 + - *294 - name: repo in: path description: The name of the controller repository. @@ -59206,7 +60151,7 @@ paths: type: object properties: repository: *51 - analysis_status: *406 + analysis_status: *416 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -59331,8 +60276,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *289 - - *290 + - *294 + - *295 responses: '200': description: Response @@ -59425,7 +60370,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *387 + '403': *397 '404': *6 '503': *62 x-github: @@ -59446,8 +60391,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: @@ -59516,7 +60461,7 @@ paths: description: Response content: application/json: - schema: *125 + schema: *128 examples: default: value: @@ -59541,7 +60486,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *393 + '403': *403 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -59612,8 +60557,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: @@ -59621,7 +60566,7 @@ paths: schema: type: object properties: - commit_sha: *407 + commit_sha: *417 ref: type: string description: |- @@ -59681,7 +60626,7 @@ paths: schema: type: object properties: - id: *398 + id: *408 url: type: string description: The REST API URL for checking the status of the upload. @@ -59695,7 +60640,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': *393 + '403': *403 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -59718,8 +60663,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *289 - - *290 + - *294 + - *295 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -59767,7 +60712,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': *387 + '403': *397 '404': description: Not Found if the sarif id does not match any upload '503': *62 @@ -59792,8 +60737,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: - - *289 - - *290 + - *294 + - *295 responses: '200': description: Response @@ -59849,7 +60794,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': *142 + '204': *145 '304': *35 '403': *27 '404': *6 @@ -59874,8 +60819,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-codeowners-errors parameters: - - *289 - - *290 + - *294 + - *295 - 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 @@ -60003,8 +60948,8 @@ paths: parameters: - *17 - *19 - - *289 - - *290 + - *294 + - *295 responses: '200': description: Response @@ -60020,7 +60965,7 @@ paths: type: integer codespaces: type: array - items: *192 + items: *195 examples: default: value: @@ -60296,7 +61241,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': *91 + '500': *94 '401': *23 '403': *27 '404': *6 @@ -60318,8 +61263,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: @@ -60383,17 +61328,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *192 + schema: *195 examples: - default: *408 + default: *418 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *192 + schema: *195 examples: - default: *408 + default: *418 '400': *14 '401': *23 '403': *27 @@ -60422,8 +61367,8 @@ paths: parameters: - *17 - *19 - - *289 - - *290 + - *294 + - *295 responses: '200': description: Response @@ -60463,7 +61408,7 @@ paths: - path: ".devcontainer.json" display_name: Default project configuration total_count: 3 - '500': *91 + '500': *94 '400': *14 '401': *23 '403': *27 @@ -60487,8 +61432,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *289 - - *290 + - *294 + - *295 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -60525,9 +61470,9 @@ paths: type: integer machines: type: array - items: *409 + items: *419 examples: - default: &610 + default: &621 value: total_count: 2 machines: @@ -60544,7 +61489,7 @@ paths: memory_in_bytes: 34359738368 cpus: 8 '304': *35 - '500': *91 + '500': *94 '401': *23 '403': *27 '404': *6 @@ -60567,8 +61512,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *289 - - *290 + - *294 + - *295 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -60655,8 +61600,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: - - *289 - - *290 + - *294 + - *295 - 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 @@ -60725,8 +61670,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *289 - - *290 + - *294 + - *295 - *17 - *19 responses: @@ -60744,7 +61689,7 @@ paths: type: integer secrets: type: array - items: &413 + items: &423 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -60765,7 +61710,7 @@ paths: - created_at - updated_at examples: - default: *410 + default: *420 headers: Link: *57 x-github: @@ -60788,16 +61733,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *289 - - *290 + - *294 + - *295 responses: '200': description: Response content: application/json: - schema: *411 + schema: *421 examples: - default: *412 + default: *422 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -60817,17 +61762,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *289 - - *290 - - *124 + - *294 + - *295 + - *127 responses: '200': description: Response content: application/json: - schema: *413 + schema: *423 examples: - default: *414 + default: *424 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60847,9 +61792,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *289 - - *290 - - *124 + - *294 + - *295 + - *127 requestBody: required: true content: @@ -60877,7 +61822,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *125 + schema: *128 examples: default: value: @@ -60901,9 +61846,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *289 - - *290 - - *124 + - *294 + - *295 + - *127 responses: '204': description: Response @@ -60931,8 +61876,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators parameters: - - *289 - - *290 + - *294 + - *295 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -60970,7 +61915,7 @@ paths: application/json: schema: type: array - items: &415 + items: &425 title: Collaborator description: Collaborator type: object @@ -61163,9 +62108,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *289 - - *290 - - *129 + - *294 + - *295 + - *132 responses: '204': description: Response if user is a collaborator @@ -61211,9 +62156,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *289 - - *290 - - *129 + - *294 + - *295 + - *132 requestBody: required: false content: @@ -61239,7 +62184,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &479 + schema: &489 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -61251,7 +62196,7 @@ paths: format: int64 examples: - 42 - repository: *116 + repository: *119 invitee: anyOf: - type: 'null' @@ -61427,7 +62372,7 @@ paths: - an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts content: application/json: - schema: *94 + schema: *97 '403': *27 x-github: triggersNotification: true @@ -61467,9 +62412,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *289 - - *290 - - *129 + - *294 + - *295 + - *132 responses: '204': description: No Content when collaborator was removed from the repository. @@ -61500,9 +62445,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *289 - - *290 - - *129 + - *294 + - *295 + - *132 responses: '200': description: if user has admin permissions @@ -61522,7 +62467,7 @@ paths: user: anyOf: - type: 'null' - - *415 + - *425 required: - permission - role_name @@ -61576,8 +62521,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *289 - - *290 + - *294 + - *295 - *17 - *19 responses: @@ -61587,7 +62532,7 @@ paths: application/json: schema: type: array - items: &416 + items: &426 title: Commit Comment description: Commit Comment type: object @@ -61645,7 +62590,7 @@ paths: - created_at - updated_at examples: - default: &419 + default: &429 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -61704,17 +62649,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#get-a-commit-comment parameters: - - *289 - - *290 + - *294 + - *295 - *73 responses: '200': description: Response content: application/json: - schema: *416 + schema: *426 examples: - default: &420 + default: &430 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -61771,8 +62716,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#update-a-commit-comment parameters: - - *289 - - *290 + - *294 + - *295 - *73 requestBody: required: true @@ -61795,7 +62740,7 @@ paths: description: Response content: application/json: - schema: *416 + schema: *426 examples: default: value: @@ -61846,8 +62791,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment parameters: - - *289 - - *290 + - *294 + - *295 - *73 responses: '204': @@ -61869,8 +62814,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *289 - - *290 + - *294 + - *295 - *73 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -61897,9 +62842,9 @@ paths: application/json: schema: type: array - items: *282 + items: *287 examples: - default: *284 + default: *289 headers: Link: *57 '404': *6 @@ -61920,8 +62865,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *289 - - *290 + - *294 + - *295 - *73 requestBody: required: true @@ -61954,16 +62899,16 @@ paths: description: Reaction exists content: application/json: - schema: *282 + schema: *287 examples: - default: *283 + default: *288 '201': description: Reaction created content: application/json: - schema: *282 + schema: *287 examples: - default: *283 + default: *288 '422': *15 x-github: githubCloudOnly: false @@ -61985,10 +62930,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *289 - - *290 + - *294 + - *295 - *73 - - *285 + - *290 responses: '204': description: Response @@ -62037,8 +62982,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-commits parameters: - - *289 - - *290 + - *294 + - *295 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -62094,9 +63039,9 @@ paths: application/json: schema: type: array - items: *417 + items: *427 examples: - default: &527 + default: &537 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -62167,7 +63112,7 @@ paths: sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e headers: Link: *57 - '500': *91 + '500': *94 '400': *14 '404': *6 '409': *45 @@ -62190,9 +63135,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit parameters: - - *289 - - *290 - - &418 + - *294 + - *295 + - &428 name: commit_sha description: The SHA of the commit. in: path @@ -62264,9 +63209,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments parameters: - - *289 - - *290 - - *418 + - *294 + - *295 + - *428 - *17 - *19 responses: @@ -62276,9 +63221,9 @@ paths: application/json: schema: type: array - items: *416 + items: *426 examples: - default: *419 + default: *429 headers: Link: *57 x-github: @@ -62306,9 +63251,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#create-a-commit-comment parameters: - - *289 - - *290 - - *418 + - *294 + - *295 + - *428 requestBody: required: true content: @@ -62343,9 +63288,9 @@ paths: description: Response content: application/json: - schema: *416 + schema: *426 examples: - default: *420 + default: *430 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -62373,9 +63318,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *289 - - *290 - - *418 + - *294 + - *295 + - *428 - *17 - *19 responses: @@ -62385,7 +63330,7 @@ paths: application/json: schema: type: array - items: &518 + items: &528 title: Pull Request Simple description: Pull Request Simple type: object @@ -62505,7 +63450,7 @@ paths: milestone: anyOf: - type: 'null' - - *421 + - *431 active_lock_reason: type: - string @@ -62560,7 +63505,7 @@ paths: type: - array - 'null' - items: *147 + items: *150 head: type: object properties: @@ -62604,7 +63549,7 @@ paths: _links: type: object properties: - comments: &422 + comments: &432 title: Link description: Hypermedia Link type: object @@ -62613,13 +63558,13 @@ paths: type: string required: - href - commits: *422 - statuses: *422 - html: *422 - issue: *422 - review_comments: *422 - review_comment: *422 - self: *422 + commits: *432 + statuses: *432 + html: *432 + issue: *432 + review_comments: *432 + review_comment: *432 + self: *432 required: - comments - commits @@ -62630,7 +63575,7 @@ paths: - review_comment - self author_association: *60 - auto_merge: &520 + auto_merge: &530 title: Auto merge description: The status of auto merging a pull request. type: @@ -62695,7 +63640,7 @@ paths: - author_association - auto_merge examples: - default: &519 + default: &529 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -63232,11 +64177,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#get-a-commit parameters: - - *289 - - *290 + - *294 + - *295 - *19 - *17 - - &423 + - &433 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)" @@ -63251,9 +64196,9 @@ paths: description: Response content: application/json: - schema: *417 + schema: *427 examples: - default: &506 + default: &516 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -63339,7 +64284,7 @@ paths: ..... '422': *15 '404': *6 - '500': *91 + '500': *94 '503': *62 '409': *45 x-github: @@ -63366,11 +64311,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *289 - - *290 - - *423 - - *424 - - *425 + - *294 + - *295 + - *433 + - *434 + - *435 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -63404,9 +64349,9 @@ paths: type: integer check_runs: type: array - items: *369 + items: *379 examples: - default: *426 + default: *436 headers: Link: *57 x-github: @@ -63431,9 +64376,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *289 - - *290 - - *423 + - *294 + - *295 + - *433 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -63441,7 +64386,7 @@ paths: schema: type: integer example: 1 - - *424 + - *434 - *17 - *19 responses: @@ -63459,7 +64404,7 @@ paths: type: integer check_suites: type: array - items: *373 + items: *383 examples: default: value: @@ -63659,9 +64604,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *289 - - *290 - - *423 + - *294 + - *295 + - *433 - *17 - *19 responses: @@ -63732,7 +64677,7 @@ paths: type: string total_count: type: integer - repository: *116 + repository: *119 commit_url: type: string format: uri @@ -63863,9 +64808,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *289 - - *290 - - *423 + - *294 + - *295 + - *433 - *17 - *19 responses: @@ -63875,7 +64820,7 @@ paths: application/json: schema: type: array - items: &583 + items: &593 title: Status description: The status of a commit. type: object @@ -63956,7 +64901,7 @@ paths: site_admin: false headers: Link: *57 - '301': *301 + '301': *306 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63984,8 +64929,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics parameters: - - *289 - - *290 + - *294 + - *295 responses: '200': description: Response @@ -64018,11 +64963,11 @@ paths: code_of_conduct: anyOf: - type: 'null' - - *427 + - *437 code_of_conduct_file: anyOf: - type: 'null' - - &428 + - &438 title: Community Health File type: object properties: @@ -64042,19 +64987,19 @@ paths: contributing: anyOf: - type: 'null' - - *428 + - *438 readme: anyOf: - type: 'null' - - *428 + - *438 issue_template: anyOf: - type: 'null' - - *428 + - *438 pull_request_template: anyOf: - type: 'null' - - *428 + - *438 required: - code_of_conduct - code_of_conduct_file @@ -64183,8 +65128,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#compare-two-commits parameters: - - *289 - - *290 + - *294 + - *295 - *19 - *17 - name: basehead @@ -64232,8 +65177,8 @@ paths: format: uri examples: - https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *417 - merge_base_commit: *417 + base_commit: *427 + merge_base_commit: *427 status: type: string enum: @@ -64257,10 +65202,10 @@ paths: - 6 commits: type: array - items: *417 + items: *427 files: type: array - items: *429 + items: *439 required: - url - html_url @@ -64503,7 +65448,7 @@ paths: patch: "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" '404': *6 - '500': *91 + '500': *94 '503': *62 x-github: githubCloudOnly: false @@ -64546,8 +65491,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-repository-content parameters: - - *289 - - *290 + - *294 + - *295 - name: path description: path parameter in: path @@ -64700,7 +65645,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &430 + response-if-content-is-a-file: &440 summary: Response if content is a file value: type: file @@ -64837,7 +65782,7 @@ paths: - size - type - url - - &532 + - &542 title: Content File description: Content File type: object @@ -65055,7 +66000,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *430 + response-if-content-is-a-file: *440 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -65124,7 +66069,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *27 - '302': *431 + '302': *441 '304': *35 x-github: githubCloudOnly: false @@ -65147,8 +66092,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents parameters: - - *289 - - *290 + - *294 + - *295 - name: path description: path parameter in: path @@ -65243,7 +66188,7 @@ paths: description: Response content: application/json: - schema: &432 + schema: &442 title: File Commit description: File Commit type: object @@ -65399,7 +66344,7 @@ paths: description: Response content: application/json: - schema: *432 + schema: *442 examples: example-for-creating-a-file: value: @@ -65453,7 +66398,7 @@ paths: schema: oneOf: - *3 - - &461 + - &471 description: Repository rule violation was detected type: object properties: @@ -65474,7 +66419,7 @@ paths: items: type: object properties: - placeholder_id: &575 + placeholder_id: &585 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -65506,8 +66451,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#delete-a-file parameters: - - *289 - - *290 + - *294 + - *295 - name: path description: path parameter in: path @@ -65568,7 +66513,7 @@ paths: description: Response content: application/json: - schema: *432 + schema: *442 examples: default: value: @@ -65623,8 +66568,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-contributors parameters: - - *289 - - *290 + - *294 + - *295 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -65748,22 +66693,22 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *289 - - *290 - - *148 - - *149 - - *150 + - *294 + - *295 - *151 + - *152 + - *153 + - *154 - 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 - - *152 - - *153 - - *154 - *155 + - *156 + - *157 + - *158 - *46 - name: page description: "**Closing down notice**. Page number of the results to fetch. @@ -65783,8 +66728,8 @@ paths: default: 30 - *38 - *39 - - *156 - - *157 + - *159 + - *160 responses: '200': description: Response @@ -65792,7 +66737,7 @@ paths: application/json: schema: type: array - items: &435 + items: &445 type: object description: A Dependabot alert. properties: @@ -65842,13 +66787,13 @@ paths: - direct - transitive - - security_advisory: *433 + security_advisory: *443 security_vulnerability: *50 url: *55 html_url: *56 created_at: *53 updated_at: *54 - dismissed_at: *134 + dismissed_at: *137 dismissed_by: anyOf: - type: 'null' @@ -65872,8 +66817,8 @@ paths: description: An optional comment associated with the alert's dismissal. maxLength: 280 - fixed_at: *133 - auto_dismissed_at: *434 + fixed_at: *136 + auto_dismissed_at: *444 required: - number - state @@ -66103,9 +67048,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *289 - - *290 - - &436 + - *294 + - *295 + - &446 name: alert_number in: path description: |- @@ -66120,7 +67065,7 @@ paths: description: Response content: application/json: - schema: *435 + schema: *445 examples: default: value: @@ -66233,9 +67178,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *289 - - *290 - - *436 + - *294 + - *295 + - *446 requestBody: required: true content: @@ -66280,7 +67225,7 @@ paths: description: Response content: application/json: - schema: *435 + schema: *445 examples: default: value: @@ -66409,8 +67354,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets parameters: - - *289 - - *290 + - *294 + - *295 - *17 - *19 responses: @@ -66428,7 +67373,7 @@ paths: type: integer secrets: type: array - items: &439 + items: &449 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -66482,16 +67427,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key parameters: - - *289 - - *290 + - *294 + - *295 responses: '200': description: Response content: application/json: - schema: *437 + schema: *447 examples: - default: *438 + default: *448 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66511,15 +67456,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret parameters: - - *289 - - *290 - - *124 + - *294 + - *295 + - *127 responses: '200': description: Response content: application/json: - schema: *439 + schema: *449 examples: default: value: @@ -66545,9 +67490,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *289 - - *290 - - *124 + - *294 + - *295 + - *127 requestBody: required: true content: @@ -66575,7 +67520,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *125 + schema: *128 examples: default: value: @@ -66599,9 +67544,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret parameters: - - *289 - - *290 - - *124 + - *294 + - *295 + - *127 responses: '204': description: Response @@ -66623,8 +67568,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: - - *289 - - *290 + - *294 + - *295 - 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 @@ -66798,8 +67743,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: - - *289 - - *290 + - *294 + - *295 responses: '200': description: Response @@ -67059,8 +68004,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: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: @@ -67143,7 +68088,7 @@ paths: - version - url additionalProperties: false - metadata: &440 + metadata: &450 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -67182,7 +68127,7 @@ paths: examples: - "/src/build/package-lock.json" additionalProperties: false - metadata: *440 + metadata: *450 resolved: type: object description: A collection of resolved package dependencies. @@ -67196,7 +68141,7 @@ paths: pattern: "^pkg" examples: - pkg:/npm/%40actions/http-client@1.0.11 - metadata: *440 + metadata: *450 relationship: type: string description: A notation of whether a dependency is requested @@ -67329,8 +68274,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#list-deployments parameters: - - *289 - - *290 + - *294 + - *295 - name: sha description: The SHA recorded at creation time. in: query @@ -67371,9 +68316,9 @@ paths: application/json: schema: type: array - items: *441 + items: *451 examples: - default: *442 + default: *452 headers: Link: *57 x-github: @@ -67439,8 +68384,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#create-a-deployment parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: @@ -67522,7 +68467,7 @@ paths: description: Response content: application/json: - schema: *441 + schema: *451 examples: simple-example: summary: Simple example @@ -67595,9 +68540,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#get-a-deployment parameters: - - *289 - - *290 - - &443 + - *294 + - *295 + - &453 name: deployment_id description: deployment_id parameter in: path @@ -67609,7 +68554,7 @@ paths: description: Response content: application/json: - schema: *441 + schema: *451 examples: default: value: @@ -67674,9 +68619,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment parameters: - - *289 - - *290 - - *443 + - *294 + - *295 + - *453 responses: '204': description: Response @@ -67698,9 +68643,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses parameters: - - *289 - - *290 - - *443 + - *294 + - *295 + - *453 - *17 - *19 responses: @@ -67710,7 +68655,7 @@ paths: application/json: schema: type: array - items: &444 + items: &454 title: Deployment Status description: The status of a deployment. type: object @@ -67874,9 +68819,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status parameters: - - *289 - - *290 - - *443 + - *294 + - *295 + - *453 requestBody: required: true content: @@ -67951,9 +68896,9 @@ paths: description: Response content: application/json: - schema: *444 + schema: *454 examples: - default: &445 + default: &455 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -68009,9 +68954,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status parameters: - - *289 - - *290 - - *443 + - *294 + - *295 + - *453 - name: status_id in: path required: true @@ -68022,9 +68967,9 @@ paths: description: Response content: application/json: - schema: *444 + schema: *454 examples: - default: *445 + default: *455 '404': *6 x-github: githubCloudOnly: false @@ -68049,8 +68994,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: @@ -68107,8 +69052,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#list-environments parameters: - - *289 - - *290 + - *294 + - *295 - *17 - *19 responses: @@ -68126,7 +69071,7 @@ paths: - 5 environments: type: array - items: &447 + items: &457 title: Environment description: Details of a deployment environment type: object @@ -68188,7 +69133,7 @@ paths: type: string examples: - wait_timer - wait_timer: &449 + wait_timer: &459 type: integer description: The amount of time to delay a job after the job is initially triggered. The time (in minutes) @@ -68230,11 +69175,11 @@ paths: items: type: object properties: - type: *446 + type: *456 reviewer: anyOf: - *4 - - *147 + - *150 required: - id - node_id @@ -68257,7 +69202,7 @@ paths: - id - node_id - type - deployment_branch_policy: &450 + deployment_branch_policy: &460 type: - object - 'null' @@ -68374,9 +69319,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#get-an-environment parameters: - - *289 - - *290 - - &448 + - *294 + - *295 + - &458 name: environment_name in: path required: true @@ -68389,9 +69334,9 @@ paths: description: Response content: application/json: - schema: *447 + schema: *457 examples: - default: &451 + default: &461 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -68475,9 +69420,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment parameters: - - *289 - - *290 - - *448 + - *294 + - *295 + - *458 requestBody: required: false content: @@ -68487,7 +69432,7 @@ paths: - object - 'null' properties: - wait_timer: *449 + wait_timer: *459 prevent_self_review: type: boolean description: Whether or not a user who created the job is prevented @@ -68506,14 +69451,14 @@ paths: items: type: object properties: - type: *446 + type: *456 id: type: integer description: The id of the user or team who can review the deployment examples: - 4532992 - deployment_branch_policy: *450 + deployment_branch_policy: *460 additionalProperties: false examples: default: @@ -68533,9 +69478,9 @@ paths: description: Response content: application/json: - schema: *447 + schema: *457 examples: - default: *451 + default: *461 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -68559,9 +69504,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#delete-an-environment parameters: - - *289 - - *290 - - *448 + - *294 + - *295 + - *458 responses: '204': description: Default response @@ -68586,9 +69531,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *289 - - *290 - - *448 + - *294 + - *295 + - *458 - *17 - *19 responses: @@ -68607,7 +69552,7 @@ paths: - 2 branch_policies: type: array - items: &452 + items: &462 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -68668,9 +69613,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *289 - - *290 - - *448 + - *294 + - *295 + - *458 requestBody: required: true content: @@ -68718,9 +69663,9 @@ paths: description: Response content: application/json: - schema: *452 + schema: *462 examples: - example-wildcard: &453 + example-wildcard: &463 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -68762,10 +69707,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *289 - - *290 - - *448 - - &454 + - *294 + - *295 + - *458 + - &464 name: branch_policy_id in: path required: true @@ -68777,9 +69722,9 @@ paths: description: Response content: application/json: - schema: *452 + schema: *462 examples: - default: *453 + default: *463 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68798,10 +69743,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *289 - - *290 - - *448 - - *454 + - *294 + - *295 + - *458 + - *464 requestBody: required: true content: @@ -68830,9 +69775,9 @@ paths: description: Response content: application/json: - schema: *452 + schema: *462 examples: - default: *453 + default: *463 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68851,10 +69796,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *289 - - *290 - - *448 - - *454 + - *294 + - *295 + - *458 + - *464 responses: '204': description: Response @@ -68879,9 +69824,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *448 - - *290 - - *289 + - *458 + - *295 + - *294 responses: '200': description: List of deployment protection rules @@ -68898,7 +69843,7 @@ paths: - 10 custom_deployment_protection_rules: type: array - items: &455 + items: &465 title: Deployment protection rule description: Deployment protection rule type: object @@ -68920,7 +69865,7 @@ paths: for the environment. examples: - true - app: &456 + app: &466 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -69023,9 +69968,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: - - *448 - - *290 - - *289 + - *458 + - *295 + - *294 requestBody: content: application/json: @@ -69046,9 +69991,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *455 + schema: *465 examples: - default: &457 + default: &467 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -69083,9 +70028,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: - - *448 - - *290 - - *289 + - *458 + - *295 + - *294 - *19 - *17 responses: @@ -69105,7 +70050,7 @@ paths: - 35 available_custom_deployment_protection_rule_integrations: type: array - items: *456 + items: *466 examples: default: value: @@ -69140,10 +70085,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *289 - - *290 - - *448 - - &458 + - *294 + - *295 + - *458 + - &468 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -69155,9 +70100,9 @@ paths: description: Response content: application/json: - schema: *455 + schema: *465 examples: - default: *457 + default: *467 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69178,10 +70123,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *448 - - *290 - - *289 - *458 + - *295 + - *294 + - *468 responses: '204': description: Response @@ -69207,9 +70152,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-environment-secrets parameters: - - *289 - - *290 - - *448 + - *294 + - *295 + - *458 - *17 - *19 responses: @@ -69227,9 +70172,9 @@ paths: type: integer secrets: type: array - items: *335 + items: *345 examples: - default: *336 + default: *346 headers: Link: *57 x-github: @@ -69254,17 +70199,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key parameters: - - *289 - - *290 - - *448 + - *294 + - *295 + - *458 responses: '200': description: Response content: application/json: - schema: *337 + schema: *347 examples: - default: *338 + default: *348 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69286,18 +70231,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret parameters: - - *289 - - *290 - - *448 - - *124 + - *294 + - *295 + - *458 + - *127 responses: '200': description: Response content: application/json: - schema: *335 + schema: *345 examples: - default: *459 + default: *469 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69319,10 +70264,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *289 - - *290 - - *448 - - *124 + - *294 + - *295 + - *458 + - *127 requestBody: required: true content: @@ -69353,7 +70298,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *125 + schema: *128 examples: default: value: @@ -69379,10 +70324,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret parameters: - - *289 - - *290 - - *448 - - *124 + - *294 + - *295 + - *458 + - *127 responses: '204': description: Default response @@ -69407,10 +70352,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-environment-variables parameters: - - *289 - - *290 - - *448 - - *311 + - *294 + - *295 + - *458 + - *316 - *19 responses: '200': @@ -69427,9 +70372,9 @@ paths: type: integer variables: type: array - items: *339 + items: *349 examples: - default: *340 + default: *350 headers: Link: *57 x-github: @@ -69452,9 +70397,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-environment-variable parameters: - - *289 - - *290 - - *448 + - *294 + - *295 + - *458 requestBody: required: true content: @@ -69481,7 +70426,7 @@ paths: description: Response content: application/json: - schema: *125 + schema: *128 examples: default: value: @@ -69506,18 +70451,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-environment-variable parameters: - - *289 - - *290 - - *448 - - *127 + - *294 + - *295 + - *458 + - *130 responses: '200': description: Response content: application/json: - schema: *339 + schema: *349 examples: - default: *460 + default: *470 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69538,10 +70483,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-environment-variable parameters: - - *289 - - *290 - - *127 - - *448 + - *294 + - *295 + - *130 + - *458 requestBody: required: true content: @@ -69583,10 +70528,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable parameters: - - *289 - - *290 - - *127 - - *448 + - *294 + - *295 + - *130 + - *458 responses: '204': description: Response @@ -69608,8 +70553,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-repository-events parameters: - - *289 - - *290 + - *294 + - *295 - *17 - *19 responses: @@ -69686,8 +70631,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#list-forks parameters: - - *289 - - *290 + - *294 + - *295 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -69709,7 +70654,7 @@ paths: application/json: schema: type: array - items: *116 + items: *119 examples: default: value: @@ -69846,8 +70791,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#create-a-fork parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: false content: @@ -69880,9 +70825,9 @@ paths: description: Response content: application/json: - schema: *300 + schema: *305 examples: - default: *302 + default: *307 '400': *14 '422': *15 '403': *27 @@ -69903,8 +70848,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#create-a-blob parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: @@ -69963,8 +70908,8 @@ paths: application/json: schema: oneOf: - - *94 - - *461 + - *97 + - *471 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69989,8 +70934,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#get-a-blob parameters: - - *289 - - *290 + - *294 + - *295 - name: file_sha in: path required: true @@ -70090,8 +71035,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#create-a-commit parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: @@ -70200,7 +71145,7 @@ paths: description: Response content: application/json: - schema: &462 + schema: &472 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -70427,15 +71372,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#get-a-commit-object parameters: - - *289 - - *290 - - *418 + - *294 + - *295 + - *428 responses: '200': description: Response content: application/json: - schema: *462 + schema: *472 examples: default: value: @@ -70491,9 +71436,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#list-matching-references parameters: - - *289 - - *290 - - &463 + - *294 + - *295 + - &473 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. @@ -70510,7 +71455,7 @@ paths: application/json: schema: type: array - items: &464 + items: &474 title: Git Reference description: Git references within a repository type: object @@ -70586,17 +71531,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#get-a-reference parameters: - - *289 - - *290 - - *463 + - *294 + - *295 + - *473 responses: '200': description: Response content: application/json: - schema: *464 + schema: *474 examples: - default: &465 + default: &475 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -70625,8 +71570,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#create-a-reference parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: @@ -70655,9 +71600,9 @@ paths: description: Response content: application/json: - schema: *464 + schema: *474 examples: - default: *465 + default: *475 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -70683,9 +71628,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#update-a-reference parameters: - - *289 - - *290 - - *463 + - *294 + - *295 + - *473 requestBody: required: true content: @@ -70714,9 +71659,9 @@ paths: description: Response content: application/json: - schema: *464 + schema: *474 examples: - default: *465 + default: *475 '422': *15 '409': *45 x-github: @@ -70734,9 +71679,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#delete-a-reference parameters: - - *289 - - *290 - - *463 + - *294 + - *295 + - *473 responses: '204': description: Response @@ -70791,8 +71736,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#create-a-tag-object parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: @@ -70859,7 +71804,7 @@ paths: description: Response content: application/json: - schema: &467 + schema: &477 title: Git Tag description: Metadata for a Git tag type: object @@ -70915,7 +71860,7 @@ paths: - sha - type - url - verification: *466 + verification: *476 required: - sha - url @@ -70925,7 +71870,7 @@ paths: - tag - message examples: - default: &468 + default: &478 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -70998,8 +71943,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#get-a-tag parameters: - - *289 - - *290 + - *294 + - *295 - name: tag_sha in: path required: true @@ -71010,9 +71955,9 @@ paths: description: Response content: application/json: - schema: *467 + schema: *477 examples: - default: *468 + default: *478 '404': *6 '409': *45 x-github: @@ -71036,8 +71981,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#create-a-tree parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: @@ -71111,7 +72056,7 @@ paths: description: Response content: application/json: - schema: &469 + schema: &479 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -71213,8 +72158,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#get-a-tree parameters: - - *289 - - *290 + - *294 + - *295 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -71237,7 +72182,7 @@ paths: description: Response content: application/json: - schema: *469 + schema: *479 examples: default-response: summary: Default response @@ -71296,8 +72241,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks parameters: - - *289 - - *290 + - *294 + - *295 - *17 - *19 responses: @@ -71307,7 +72252,7 @@ paths: application/json: schema: type: array - items: &470 + items: &480 title: Webhook description: Webhooks for repositories. type: object @@ -71370,7 +72315,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &690 + last_response: &700 title: Hook Response type: object properties: @@ -71447,8 +72392,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: false content: @@ -71501,9 +72446,9 @@ paths: description: Response content: application/json: - schema: *470 + schema: *480 examples: - default: &471 + default: &481 value: type: Repository id: 12345678 @@ -71551,17 +72496,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook parameters: - - *289 - - *290 - - *163 + - *294 + - *295 + - *166 responses: '200': description: Response content: application/json: - schema: *470 + schema: *480 examples: - default: *471 + default: *481 '404': *6 x-github: githubCloudOnly: false @@ -71581,9 +72526,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook parameters: - - *289 - - *290 - - *163 + - *294 + - *295 + - *166 requestBody: required: true content: @@ -71628,9 +72573,9 @@ paths: description: Response content: application/json: - schema: *470 + schema: *480 examples: - default: *471 + default: *481 '422': *15 '404': *6 x-github: @@ -71651,9 +72596,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook parameters: - - *289 - - *290 - - *163 + - *294 + - *295 + - *166 responses: '204': description: Response @@ -71677,9 +72622,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *289 - - *290 - - *163 + - *294 + - *295 + - *166 responses: '200': description: Response @@ -71706,9 +72651,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *289 - - *290 - - *163 + - *294 + - *295 + - *166 requestBody: required: false content: @@ -71752,11 +72697,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *289 - - *290 - - *163 + - *294 + - *295 + - *166 - *17 - - *164 + - *167 responses: '200': description: Response @@ -71764,9 +72709,9 @@ paths: application/json: schema: type: array - items: *165 + items: *168 examples: - default: *166 + default: *169 '400': *14 '422': *15 x-github: @@ -71785,18 +72730,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *289 - - *290 - - *163 + - *294 + - *295 + - *166 - *16 responses: '200': description: Response content: application/json: - schema: *167 + schema: *170 examples: - default: *168 + default: *171 '400': *14 '422': *15 x-github: @@ -71815,9 +72760,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *289 - - *290 - - *163 + - *294 + - *295 + - *166 - *16 responses: '202': *37 @@ -71840,9 +72785,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook parameters: - - *289 - - *290 - - *163 + - *294 + - *295 + - *166 responses: '204': description: Response @@ -71867,9 +72812,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *289 - - *290 - - *163 + - *294 + - *295 + - *166 responses: '204': description: Response @@ -71927,14 +72872,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status parameters: - - *289 - - *290 + - *294 + - *295 responses: '200': description: Response content: application/json: - schema: &472 + schema: &482 title: Import description: A repository import from an external source. type: object @@ -72041,7 +72986,7 @@ paths: - html_url - authors_url examples: - default: &475 + default: &485 value: vcs: subversion use_lfs: true @@ -72057,7 +73002,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': &473 + '503': &483 description: Unavailable due to service under maintenance. content: application/json: @@ -72086,8 +73031,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#start-an-import parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: @@ -72135,7 +73080,7 @@ paths: description: Response content: application/json: - schema: *472 + schema: *482 examples: default: value: @@ -72160,7 +73105,7 @@ paths: type: string '422': *15 '404': *6 - '503': *473 + '503': *483 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72188,8 +73133,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-an-import parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: false content: @@ -72241,7 +73186,7 @@ paths: description: Response content: application/json: - schema: *472 + schema: *482 examples: example-1: summary: Example 1 @@ -72289,7 +73234,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': *473 + '503': *483 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72312,12 +73257,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import parameters: - - *289 - - *290 + - *294 + - *295 responses: '204': description: Response - '503': *473 + '503': *483 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72343,9 +73288,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors parameters: - - *289 - - *290 - - &633 + - *294 + - *295 + - &643 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -72359,7 +73304,7 @@ paths: application/json: schema: type: array - items: &474 + items: &484 title: Porter Author description: Porter Author type: object @@ -72413,7 +73358,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': *473 + '503': *483 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72438,8 +73383,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author parameters: - - *289 - - *290 + - *294 + - *295 - name: author_id in: path required: true @@ -72469,7 +73414,7 @@ paths: description: Response content: application/json: - schema: *474 + schema: *484 examples: default: value: @@ -72482,7 +73427,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *473 + '503': *483 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72506,8 +73451,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-large-files parameters: - - *289 - - *290 + - *294 + - *295 responses: '200': description: Response @@ -72548,7 +73493,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *473 + '503': *483 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72576,8 +73521,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: @@ -72604,11 +73549,11 @@ paths: description: Response content: application/json: - schema: *472 + schema: *482 examples: - default: *475 + default: *485 '422': *15 - '503': *473 + '503': *483 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72631,8 +73576,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *289 - - *290 + - *294 + - *295 responses: '200': description: Response @@ -72640,8 +73585,8 @@ paths: application/json: schema: *20 examples: - default: *476 - '301': *301 + default: *486 + '301': *306 '404': *6 x-github: githubCloudOnly: false @@ -72661,8 +73606,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *289 - - *290 + - *294 + - *295 responses: '200': description: Response @@ -72670,12 +73615,12 @@ paths: application/json: schema: anyOf: - - *181 + - *184 - type: object properties: {} additionalProperties: false examples: - default: &478 + default: &488 value: limit: collaborators_only origin: repository @@ -72700,13 +73645,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: application/json: - schema: *477 + schema: *487 examples: default: summary: Example request body @@ -72718,9 +73663,9 @@ paths: description: Response content: application/json: - schema: *181 + schema: *184 examples: - default: *478 + default: *488 '409': description: Response x-github: @@ -72742,8 +73687,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *289 - - *290 + - *294 + - *295 responses: '204': description: Response @@ -72766,8 +73711,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations parameters: - - *289 - - *290 + - *294 + - *295 - *17 - *19 responses: @@ -72777,9 +73722,9 @@ paths: application/json: schema: type: array - items: *479 + items: *489 examples: - default: &626 + default: &636 value: - id: 1 repository: @@ -72910,9 +73855,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation parameters: - - *289 - - *290 - - *185 + - *294 + - *295 + - *188 requestBody: required: false content: @@ -72941,7 +73886,7 @@ paths: description: Response content: application/json: - schema: *479 + schema: *489 examples: default: value: @@ -73072,9 +74017,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *289 - - *290 - - *185 + - *294 + - *295 + - *188 responses: '204': description: Response @@ -73105,8 +74050,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-repository-issues parameters: - - *289 - - *290 + - *294 + - *295 - 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 @@ -73154,7 +74099,7 @@ paths: required: false schema: type: string - - *189 + - *192 - name: sort description: What to sort results by. in: query @@ -73179,7 +74124,7 @@ paths: type: array items: *74 examples: - default: &488 + default: &496 value: - id: 1 node_id: MDU6SXNzdWUx @@ -73327,7 +74272,7 @@ paths: state_reason: completed headers: Link: *57 - '301': *301 + '301': *306 '422': *15 '404': *6 x-github: @@ -73356,8 +74301,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#create-an-issue parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: @@ -73449,7 +74394,7 @@ paths: application/json: schema: *74 examples: - default: &483 + default: &493 value: id: 1 node_id: MDU6SXNzdWUx @@ -73605,7 +74550,7 @@ paths: '422': *15 '503': *62 '404': *6 - '410': *298 + '410': *303 x-github: triggersNotification: true githubCloudOnly: false @@ -73633,8 +74578,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *289 - - *290 + - *294 + - *295 - *83 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. @@ -73655,9 +74600,9 @@ paths: application/json: schema: type: array - items: *480 + items: *490 examples: - default: &485 + default: &495 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -73715,17 +74660,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#get-an-issue-comment parameters: - - *289 - - *290 + - *294 + - *295 - *73 responses: '200': description: Response content: application/json: - schema: *480 + schema: *490 examples: - default: &481 + default: &491 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -73779,8 +74724,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#update-an-issue-comment parameters: - - *289 - - *290 + - *294 + - *295 - *73 requestBody: required: true @@ -73803,9 +74748,9 @@ paths: description: Response content: application/json: - schema: *480 + schema: *490 examples: - default: *481 + default: *491 '422': *15 x-github: githubCloudOnly: false @@ -73823,8 +74768,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment parameters: - - *289 - - *290 + - *294 + - *295 - *73 responses: '204': @@ -73845,8 +74790,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *289 - - *290 + - *294 + - *295 - *73 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -73873,9 +74818,9 @@ paths: application/json: schema: type: array - items: *282 + items: *287 examples: - default: *284 + default: *289 headers: Link: *57 '404': *6 @@ -73896,8 +74841,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *289 - - *290 + - *294 + - *295 - *73 requestBody: required: true @@ -73930,16 +74875,16 @@ paths: description: Reaction exists content: application/json: - schema: *282 + schema: *287 examples: - default: *283 + default: *288 '201': description: Reaction created content: application/json: - schema: *282 + schema: *287 examples: - default: *283 + default: *288 '422': *15 x-github: githubCloudOnly: false @@ -73961,10 +74906,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *289 - - *290 + - *294 + - *295 - *73 - - *285 + - *290 responses: '204': description: Response @@ -73984,8 +74929,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository parameters: - - *289 - - *290 + - *294 + - *295 - *17 - *19 responses: @@ -73995,7 +74940,7 @@ paths: application/json: schema: type: array - items: &482 + items: &492 title: Issue Event description: Issue Event type: object @@ -74075,7 +75020,7 @@ paths: anyOf: - type: 'null' - *4 - requested_team: *147 + requested_team: *150 dismissed_review: title: Issue Event Dismissed Review type: object @@ -74334,8 +75279,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#get-an-issue-event parameters: - - *289 - - *290 + - *294 + - *295 - name: event_id in: path required: true @@ -74346,7 +75291,7 @@ paths: description: Response content: application/json: - schema: *482 + schema: *492 examples: default: value: @@ -74539,7 +75484,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *298 + '410': *303 '403': *27 x-github: githubCloudOnly: false @@ -74573,9 +75518,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#get-an-issue parameters: - - *289 - - *290 - - &484 + - *294 + - *295 + - &494 name: issue_number description: The number that identifies the issue. in: path @@ -74589,10 +75534,10 @@ paths: application/json: schema: *74 examples: - default: *483 - '301': *301 + default: *493 + '301': *306 '404': *6 - '410': *298 + '410': *303 '304': *35 x-github: githubCloudOnly: false @@ -74617,9 +75562,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#update-an-issue parameters: - - *289 - - *290 - - *484 + - *294 + - *295 + - *494 requestBody: required: false content: @@ -74740,13 +75685,13 @@ paths: application/json: schema: *74 examples: - default: *483 + default: *493 '422': *15 '503': *62 '403': *27 - '301': *301 + '301': *306 '404': *6 - '410': *298 + '410': *303 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74764,9 +75709,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue parameters: - - *289 - - *290 - - *484 + - *294 + - *295 + - *494 requestBody: required: false content: @@ -74794,7 +75739,7 @@ paths: application/json: schema: *74 examples: - default: *483 + default: *493 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74810,9 +75755,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *289 - - *290 - - *484 + - *294 + - *295 + - *494 requestBody: content: application/json: @@ -74839,7 +75784,7 @@ paths: application/json: schema: *74 examples: - default: *483 + default: *493 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74861,9 +75806,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: - - *289 - - *290 - - *484 + - *294 + - *295 + - *494 - name: assignee in: path required: true @@ -74903,9 +75848,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments parameters: - - *289 - - *290 - - *484 + - *294 + - *295 + - *494 - *64 - *17 - *19 @@ -74916,13 +75861,13 @@ paths: application/json: schema: type: array - items: *480 + items: *490 examples: - default: *485 + default: *495 headers: Link: *57 '404': *6 - '410': *298 + '410': *303 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74951,9 +75896,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#create-an-issue-comment parameters: - - *289 - - *290 - - *484 + - *294 + - *295 + - *494 requestBody: required: true content: @@ -74975,16 +75920,16 @@ paths: description: Response content: application/json: - schema: *480 + schema: *490 examples: - default: *481 + default: *491 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *27 - '410': *298 + '410': *303 '422': *15 '404': *6 x-github: @@ -74993,6 +75938,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: + - *294 + - *295 + - *494 + - *17 + - *19 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: *74 + examples: + default: *496 + headers: + Link: *57 + '301': *306 + '404': *6 + '410': *303 + 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: + - *294 + - *295 + - *494 + 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: *74 + examples: + default: *493 + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by + schema: + type: string + '301': *306 + '403': *27 + '410': *303 + '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: + - *294 + - *295 + - *494 + - 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: *74 + examples: + default: *493 + '301': *306 + '400': *14 + '401': *23 + '403': *27 + '404': *6 + '410': *303 + 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: + - *294 + - *295 + - *494 + - *17 + - *19 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: *74 + examples: + default: *496 + headers: + Link: *57 + '301': *306 + '404': *6 + '410': *303 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies "/repos/{owner}/{repo}/issues/{issue_number}/events": get: summary: List issue events @@ -75004,9 +76153,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events parameters: - - *289 - - *290 - - *484 + - *294 + - *295 + - *494 - *17 - *19 responses: @@ -75020,7 +76169,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &489 + - &499 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -75069,7 +76218,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &490 + - &500 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -75197,7 +76346,7 @@ paths: - performed_via_github_app - assignee - assigner - - &491 + - &501 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -75243,7 +76392,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &492 + - &502 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -75289,7 +76438,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &493 + - &503 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -75338,7 +76487,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &494 + - &504 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -75367,7 +76516,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *147 + requested_team: *150 requested_reviewer: *4 required: - review_requester @@ -75380,7 +76529,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &495 + - &505 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -75409,7 +76558,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *147 + requested_team: *150 requested_reviewer: *4 required: - review_requester @@ -75422,7 +76571,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &496 + - &506 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -75478,7 +76627,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &497 + - &507 title: Locked Issue Event description: Locked Issue Event type: object @@ -75523,7 +76672,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &498 + - &508 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -75584,7 +76733,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &499 + - &509 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -75645,7 +76794,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &500 + - &510 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -75706,7 +76855,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &501 + - &511 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -75799,7 +76948,7 @@ paths: color: red headers: Link: *57 - '410': *298 + '410': *303 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75816,9 +76965,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue parameters: - - *289 - - *290 - - *484 + - *294 + - *295 + - *494 - *17 - *19 responses: @@ -75828,7 +76977,7 @@ paths: application/json: schema: type: array - items: &486 + items: &497 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -75883,7 +77032,7 @@ paths: - color - default examples: - default: &487 + default: &498 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -75901,9 +77050,9 @@ paths: default: false headers: Link: *57 - '301': *301 + '301': *306 '404': *6 - '410': *298 + '410': *303 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75920,9 +77069,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue parameters: - - *289 - - *290 - - *484 + - *294 + - *295 + - *494 requestBody: required: false content: @@ -75981,12 +77130,12 @@ paths: application/json: schema: type: array - items: *486 + items: *497 examples: - default: *487 - '301': *301 + default: *498 + '301': *306 '404': *6 - '410': *298 + '410': *303 '422': *15 x-github: githubCloudOnly: false @@ -76003,9 +77152,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue parameters: - - *289 - - *290 - - *484 + - *294 + - *295 + - *494 requestBody: required: false content: @@ -76065,12 +77214,12 @@ paths: application/json: schema: type: array - items: *486 + items: *497 examples: - default: *487 - '301': *301 + default: *498 + '301': *306 '404': *6 - '410': *298 + '410': *303 '422': *15 x-github: githubCloudOnly: false @@ -76087,15 +77236,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *289 - - *290 - - *484 + - *294 + - *295 + - *494 responses: '204': description: Response - '301': *301 + '301': *306 '404': *6 - '410': *298 + '410': *303 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76114,9 +77263,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue parameters: - - *289 - - *290 - - *484 + - *294 + - *295 + - *494 - name: name in: path required: true @@ -76129,7 +77278,7 @@ paths: application/json: schema: type: array - items: *486 + items: *497 examples: default: value: @@ -76140,9 +77289,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *301 + '301': *306 '404': *6 - '410': *298 + '410': *303 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76162,9 +77311,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#lock-an-issue parameters: - - *289 - - *290 - - *484 + - *294 + - *295 + - *494 requestBody: required: false content: @@ -76193,7 +77342,7 @@ paths: '204': description: Response '403': *27 - '410': *298 + '410': *303 '404': *6 '422': *15 x-github: @@ -76211,9 +77360,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#unlock-an-issue parameters: - - *289 - - *290 - - *484 + - *294 + - *295 + - *494 responses: '204': description: Response @@ -76235,9 +77384,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *289 - - *290 - - *484 + - *294 + - *295 + - *494 - 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. @@ -76263,13 +77412,13 @@ paths: application/json: schema: type: array - items: *282 + items: *287 examples: - default: *284 + default: *289 headers: Link: *57 '404': *6 - '410': *298 + '410': *303 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76287,9 +77436,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *289 - - *290 - - *484 + - *294 + - *295 + - *494 requestBody: required: true content: @@ -76321,16 +77470,16 @@ paths: description: Response content: application/json: - schema: *282 + schema: *287 examples: - default: *283 + default: *288 '201': description: Response content: application/json: - schema: *282 + schema: *287 examples: - default: *283 + default: *288 '422': *15 x-github: githubCloudOnly: false @@ -76352,10 +77501,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction parameters: - - *289 + - *294 + - *295 + - *494 - *290 - - *484 - - *285 responses: '204': description: Response @@ -76384,9 +77533,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue parameters: - - *289 - - *290 - - *484 + - *294 + - *295 + - *494 requestBody: required: true content: @@ -76410,7 +77559,7 @@ paths: application/json: schema: *74 examples: - default: *483 + default: *493 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -76443,9 +77592,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues parameters: - - *289 - - *290 - - *484 + - *294 + - *295 + - *494 - *17 - *19 responses: @@ -76457,11 +77606,11 @@ paths: type: array items: *74 examples: - default: *488 + default: *496 headers: Link: *57 '404': *6 - '410': *298 + '410': *303 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76489,9 +77638,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue parameters: - - *289 - - *290 - - *484 + - *294 + - *295 + - *494 requestBody: required: true content: @@ -76520,14 +77669,14 @@ paths: application/json: schema: *74 examples: - default: *483 + default: *493 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *27 - '410': *298 + '410': *303 '422': *15 '404': *6 x-github: @@ -76547,9 +77696,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *289 - - *290 - - *484 + - *294 + - *295 + - *494 requestBody: required: true content: @@ -76582,7 +77731,7 @@ paths: application/json: schema: *74 examples: - default: *483 + default: *493 '403': *27 '404': *6 '422': *7 @@ -76604,9 +77753,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *289 - - *290 - - *484 + - *294 + - *295 + - *494 - *17 - *19 responses: @@ -76621,19 +77770,19 @@ paths: description: Timeline Event type: object anyOf: - - *489 - - *490 - - *491 - - *492 - - *493 - - *494 - - *495 - - *496 - - *497 - - *498 - *499 - *500 - *501 + - *502 + - *503 + - *504 + - *505 + - *506 + - *507 + - *508 + - *509 + - *510 + - *511 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -76957,7 +78106,7 @@ paths: type: string comments: type: array - items: &521 + items: &531 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -77195,7 +78344,7 @@ paths: type: string comments: type: array - items: *416 + items: *426 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -77470,7 +78619,7 @@ paths: headers: Link: *57 '404': *6 - '410': *298 + '410': *303 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77487,8 +78636,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *289 - - *290 + - *294 + - *295 - *17 - *19 responses: @@ -77498,7 +78647,7 @@ paths: application/json: schema: type: array - items: &502 + items: &512 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -77566,8 +78715,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: @@ -77603,9 +78752,9 @@ paths: description: Response content: application/json: - schema: *502 + schema: *512 examples: - default: &503 + default: &513 value: id: 1 key: ssh-rsa AAA... @@ -77639,9 +78788,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *289 - - *290 - - &504 + - *294 + - *295 + - &514 name: key_id description: The unique identifier of the key. in: path @@ -77653,9 +78802,9 @@ paths: description: Response content: application/json: - schema: *502 + schema: *512 examples: - default: *503 + default: *513 '404': *6 x-github: githubCloudOnly: false @@ -77673,9 +78822,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *289 - - *290 - - *504 + - *294 + - *295 + - *514 responses: '204': description: Response @@ -77695,8 +78844,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository parameters: - - *289 - - *290 + - *294 + - *295 - *17 - *19 responses: @@ -77706,9 +78855,9 @@ paths: application/json: schema: type: array - items: *486 + items: *497 examples: - default: *487 + default: *498 headers: Link: *57 '404': *6 @@ -77729,8 +78878,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#create-a-label parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: @@ -77766,9 +78915,9 @@ paths: description: Response content: application/json: - schema: *486 + schema: *497 examples: - default: &505 + default: &515 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -77800,8 +78949,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#get-a-label parameters: - - *289 - - *290 + - *294 + - *295 - name: name in: path required: true @@ -77812,9 +78961,9 @@ paths: description: Response content: application/json: - schema: *486 + schema: *497 examples: - default: *505 + default: *515 '404': *6 x-github: githubCloudOnly: false @@ -77831,8 +78980,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#update-a-label parameters: - - *289 - - *290 + - *294 + - *295 - name: name in: path required: true @@ -77871,7 +79020,7 @@ paths: description: Response content: application/json: - schema: *486 + schema: *497 examples: default: value: @@ -77897,8 +79046,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#delete-a-label parameters: - - *289 - - *290 + - *294 + - *295 - name: name in: path required: true @@ -77924,8 +79073,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-languages parameters: - - *289 - - *290 + - *294 + - *295 responses: '200': description: Response @@ -77964,9 +79113,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *289 - - *290 - - *394 + - *294 + - *295 + - *404 responses: '200': description: Response @@ -78113,8 +79262,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: @@ -78179,8 +79328,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#merge-a-branch parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: @@ -78214,9 +79363,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *417 + schema: *427 examples: - default: *506 + default: *516 '204': description: Response when already merged '404': @@ -78241,8 +79390,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#list-milestones parameters: - - *289 - - *290 + - *294 + - *295 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -78283,7 +79432,7 @@ paths: application/json: schema: type: array - items: *421 + items: *431 examples: default: value: @@ -78339,8 +79488,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#create-a-milestone parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: @@ -78380,9 +79529,9 @@ paths: description: Response content: application/json: - schema: *421 + schema: *431 examples: - default: &507 + default: &517 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -78441,9 +79590,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#get-a-milestone parameters: - - *289 - - *290 - - &508 + - *294 + - *295 + - &518 name: milestone_number description: The number that identifies the milestone. in: path @@ -78455,9 +79604,9 @@ paths: description: Response content: application/json: - schema: *421 + schema: *431 examples: - default: *507 + default: *517 '404': *6 x-github: githubCloudOnly: false @@ -78474,9 +79623,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#update-a-milestone parameters: - - *289 - - *290 - - *508 + - *294 + - *295 + - *518 requestBody: required: false content: @@ -78514,9 +79663,9 @@ paths: description: Response content: application/json: - schema: *421 + schema: *431 examples: - default: *507 + default: *517 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78532,9 +79681,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#delete-a-milestone parameters: - - *289 - - *290 - - *508 + - *294 + - *295 + - *518 responses: '204': description: Response @@ -78555,9 +79704,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *289 - - *290 - - *508 + - *294 + - *295 + - *518 - *17 - *19 responses: @@ -78567,9 +79716,9 @@ paths: application/json: schema: type: array - items: *486 + items: *497 examples: - default: *487 + default: *498 headers: Link: *57 x-github: @@ -78588,12 +79737,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *289 - - *290 - - *509 - - *510 + - *294 + - *295 + - *519 + - *520 - *64 - - *511 + - *521 - *17 - *19 responses: @@ -78605,7 +79754,7 @@ paths: type: array items: *86 examples: - default: *512 + default: *522 headers: Link: *57 x-github: @@ -78629,8 +79778,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: false content: @@ -78688,14 +79837,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site parameters: - - *289 - - *290 + - *294 + - *295 responses: '200': description: Response content: application/json: - schema: &513 + schema: &523 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -78839,7 +79988,7 @@ paths: - custom_404 - public examples: - default: &514 + default: &524 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -78880,8 +80029,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: @@ -78936,9 +80085,9 @@ paths: description: Response content: application/json: - schema: *513 + schema: *523 examples: - default: *514 + default: *524 '422': *15 '409': *45 x-github: @@ -78961,8 +80110,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: @@ -79062,8 +80211,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site parameters: - - *289 - - *290 + - *294 + - *295 responses: '204': description: Response @@ -79089,8 +80238,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds parameters: - - *289 - - *290 + - *294 + - *295 - *17 - *19 responses: @@ -79100,7 +80249,7 @@ paths: application/json: schema: type: array - items: &515 + items: &525 title: Page Build description: Page Build type: object @@ -79192,8 +80341,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build parameters: - - *289 - - *290 + - *294 + - *295 responses: '201': description: Response @@ -79240,16 +80389,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-latest-pages-build parameters: - - *289 - - *290 + - *294 + - *295 responses: '200': description: Response content: application/json: - schema: *515 + schema: *525 examples: - default: &516 + default: &526 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -79297,8 +80446,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build parameters: - - *289 - - *290 + - *294 + - *295 - name: build_id in: path required: true @@ -79309,9 +80458,9 @@ paths: description: Response content: application/json: - schema: *515 + schema: *525 examples: - default: *516 + default: *526 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79331,8 +80480,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: @@ -79440,9 +80589,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *289 - - *290 - - &517 + - *294 + - *295 + - &527 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -79500,11 +80649,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *289 - - *290 - - *517 + - *294 + - *295 + - *527 responses: - '204': *142 + '204': *145 '404': *6 x-github: githubCloudOnly: false @@ -79529,8 +80678,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *289 - - *290 + - *294 + - *295 responses: '200': description: Response @@ -79798,7 +80947,7 @@ paths: description: Empty response content: application/json: - schema: *125 + schema: *128 examples: default: value: @@ -79825,8 +80974,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: - - *289 - - *290 + - *294 + - *295 responses: '200': description: Private vulnerability reporting status @@ -79863,10 +81012,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *289 - - *290 + - *294 + - *295 responses: - '204': *142 + '204': *145 '422': *14 x-github: githubCloudOnly: false @@ -79885,10 +81034,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *289 - - *290 + - *294 + - *295 responses: - '204': *142 + '204': *145 '422': *14 x-github: githubCloudOnly: false @@ -79909,8 +81058,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#list-repository-projects parameters: - - *289 - - *290 + - *294 + - *295 - name: state description: Indicates the state of the projects to return. in: query @@ -79931,7 +81080,7 @@ paths: application/json: schema: type: array - items: *221 + items: *224 examples: default: value: @@ -79971,7 +81120,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': *298 + '410': *303 '422': *7 x-github: githubCloudOnly: false @@ -79994,8 +81143,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#create-a-repository-project parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: @@ -80021,13 +81170,13 @@ paths: description: Response content: application/json: - schema: *221 + schema: *224 examples: - default: *297 + default: *302 '401': *23 '403': *27 '404': *6 - '410': *298 + '410': *303 '422': *7 x-github: githubCloudOnly: false @@ -80050,8 +81199,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *289 - - *290 + - *294 + - *295 responses: '200': description: Response @@ -80059,7 +81208,7 @@ paths: application/json: schema: type: array - items: *226 + items: *229 examples: default: value: @@ -80090,8 +81239,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: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: @@ -80103,7 +81252,7 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *226 + items: *229 required: - properties examples: @@ -80153,8 +81302,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests parameters: - - *289 - - *290 + - *294 + - *295 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -80214,9 +81363,9 @@ paths: application/json: schema: type: array - items: *518 + items: *528 examples: - default: *519 + default: *529 headers: Link: *57 '304': *35 @@ -80248,8 +81397,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: @@ -80316,7 +81465,7 @@ paths: description: Response content: application/json: - schema: &523 + schema: &533 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -80445,7 +81594,7 @@ paths: milestone: anyOf: - type: 'null' - - *421 + - *431 active_lock_reason: type: - string @@ -80500,7 +81649,7 @@ paths: type: - array - 'null' - items: *203 + items: *206 head: type: object properties: @@ -80538,14 +81687,14 @@ paths: _links: type: object properties: - comments: *422 - commits: *422 - statuses: *422 - html: *422 - issue: *422 - review_comments: *422 - review_comment: *422 - self: *422 + comments: *432 + commits: *432 + statuses: *432 + html: *432 + issue: *432 + review_comments: *432 + review_comment: *432 + self: *432 required: - comments - commits @@ -80556,7 +81705,7 @@ paths: - review_comment - self author_association: *60 - auto_merge: *520 + auto_merge: *530 draft: description: Indicates whether or not the pull request is a draft. type: boolean @@ -80658,7 +81807,7 @@ paths: - merged_by - review_comments examples: - default: &524 + default: &534 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -81185,8 +82334,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *289 - - *290 + - *294 + - *295 - name: sort in: query required: false @@ -81215,9 +82364,9 @@ paths: application/json: schema: type: array - items: *521 + items: *531 examples: - default: &526 + default: &536 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -81294,17 +82443,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *289 - - *290 + - *294 + - *295 - *73 responses: '200': description: Response content: application/json: - schema: *521 + schema: *531 examples: - default: &522 + default: &532 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -81379,8 +82528,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *289 - - *290 + - *294 + - *295 - *73 requestBody: required: true @@ -81403,9 +82552,9 @@ paths: description: Response content: application/json: - schema: *521 + schema: *531 examples: - default: *522 + default: *532 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81421,8 +82570,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *289 - - *290 + - *294 + - *295 - *73 responses: '204': @@ -81444,8 +82593,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *289 - - *290 + - *294 + - *295 - *73 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -81472,9 +82621,9 @@ paths: application/json: schema: type: array - items: *282 + items: *287 examples: - default: *284 + default: *289 headers: Link: *57 '404': *6 @@ -81495,8 +82644,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *289 - - *290 + - *294 + - *295 - *73 requestBody: required: true @@ -81529,16 +82678,16 @@ paths: description: Reaction exists content: application/json: - schema: *282 + schema: *287 examples: - default: *283 + default: *288 '201': description: Reaction created content: application/json: - schema: *282 + schema: *287 examples: - default: *283 + default: *288 '422': *15 x-github: githubCloudOnly: false @@ -81560,10 +82709,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *289 - - *290 + - *294 + - *295 - *73 - - *285 + - *290 responses: '204': description: Response @@ -81606,9 +82755,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request parameters: - - *289 - - *290 - - &525 + - *294 + - *295 + - &535 name: pull_number description: The number that identifies the pull request. in: path @@ -81621,9 +82770,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *523 + schema: *533 examples: - default: *524 + default: *534 '304': *35 '404': *6 '406': @@ -81631,7 +82780,7 @@ paths: content: application/json: schema: *3 - '500': *91 + '500': *94 '503': *62 x-github: githubCloudOnly: false @@ -81658,9 +82807,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request parameters: - - *289 - - *290 - - *525 + - *294 + - *295 + - *535 requestBody: required: false content: @@ -81702,9 +82851,9 @@ paths: description: Response content: application/json: - schema: *523 + schema: *533 examples: - default: *524 + default: *534 '422': *15 '403': *27 x-github: @@ -81726,9 +82875,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *289 - - *290 - - *525 + - *294 + - *295 + - *535 requestBody: required: true content: @@ -81789,17 +82938,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *192 + schema: *195 examples: - default: *408 + default: *418 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *192 + schema: *195 examples: - default: *408 + default: *418 '401': *23 '403': *27 '404': *6 @@ -81829,9 +82978,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *289 - - *290 - - *525 + - *294 + - *295 + - *535 - *83 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -81852,9 +83001,9 @@ paths: application/json: schema: type: array - items: *521 + items: *531 examples: - default: *526 + default: *536 headers: Link: *57 x-github: @@ -81887,9 +83036,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *289 - - *290 - - *525 + - *294 + - *295 + - *535 requestBody: required: true content: @@ -81995,7 +83144,7 @@ paths: description: Response content: application/json: - schema: *521 + schema: *531 examples: example-for-a-multi-line-comment: value: @@ -82083,9 +83232,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *289 - - *290 - - *525 + - *294 + - *295 + - *535 - *73 requestBody: required: true @@ -82108,7 +83257,7 @@ paths: description: Response content: application/json: - schema: *521 + schema: *531 examples: default: value: @@ -82194,9 +83343,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *289 - - *290 - - *525 + - *294 + - *295 + - *535 - *17 - *19 responses: @@ -82206,9 +83355,9 @@ paths: application/json: schema: type: array - items: *417 + items: *427 examples: - default: *527 + default: *537 headers: Link: *57 x-github: @@ -82238,9 +83387,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files parameters: - - *289 - - *290 - - *525 + - *294 + - *295 + - *535 - *17 - *19 responses: @@ -82250,7 +83399,7 @@ paths: application/json: schema: type: array - items: *429 + items: *439 examples: default: value: @@ -82268,7 +83417,7 @@ paths: headers: Link: *57 '422': *15 - '500': *91 + '500': *94 '503': *62 x-github: githubCloudOnly: false @@ -82288,9 +83437,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *289 - - *290 - - *525 + - *294 + - *295 + - *535 responses: '204': description: Response if pull request has been merged @@ -82313,9 +83462,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request parameters: - - *289 - - *290 - - *525 + - *294 + - *295 + - *535 requestBody: required: false content: @@ -82427,9 +83576,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *289 - - *290 - - *525 + - *294 + - *295 + - *535 responses: '200': description: Response @@ -82445,7 +83594,7 @@ paths: items: *4 teams: type: array - items: *147 + items: *150 required: - users - teams @@ -82504,9 +83653,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *289 - - *290 - - *525 + - *294 + - *295 + - *535 requestBody: required: false content: @@ -82543,7 +83692,7 @@ paths: description: Response content: application/json: - schema: *518 + schema: *528 examples: default: value: @@ -83079,9 +84228,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *289 - - *290 - - *525 + - *294 + - *295 + - *535 requestBody: required: true content: @@ -83115,7 +84264,7 @@ paths: description: Response content: application/json: - schema: *518 + schema: *528 examples: default: value: @@ -83620,9 +84769,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *289 - - *290 - - *525 + - *294 + - *295 + - *535 - *17 - *19 responses: @@ -83632,7 +84781,7 @@ paths: application/json: schema: type: array - items: &528 + items: &538 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -83788,9 +84937,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *289 - - *290 - - *525 + - *294 + - *295 + - *535 requestBody: required: false content: @@ -83880,9 +85029,9 @@ paths: description: Response content: application/json: - schema: *528 + schema: *538 examples: - default: &530 + default: &540 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -83945,10 +85094,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *289 - - *290 - - *525 - - &529 + - *294 + - *295 + - *535 + - &539 name: review_id description: The unique identifier of the review. in: path @@ -83960,9 +85109,9 @@ paths: description: Response content: application/json: - schema: *528 + schema: *538 examples: - default: &531 + default: &541 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -84021,10 +85170,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *289 - - *290 - - *525 - - *529 + - *294 + - *295 + - *535 + - *539 requestBody: required: true content: @@ -84047,7 +85196,7 @@ paths: description: Response content: application/json: - schema: *528 + schema: *538 examples: default: value: @@ -84109,18 +85258,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *289 - - *290 - - *525 - - *529 + - *294 + - *295 + - *535 + - *539 responses: '200': description: Response content: application/json: - schema: *528 + schema: *538 examples: - default: *530 + default: *540 '422': *7 '404': *6 x-github: @@ -84147,10 +85296,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *289 - - *290 - - *525 - - *529 + - *294 + - *295 + - *535 + - *539 - *17 - *19 responses: @@ -84248,9 +85397,9 @@ paths: _links: type: object properties: - self: *422 - html: *422 - pull_request: *422 + self: *432 + html: *432 + pull_request: *432 required: - self - html @@ -84408,10 +85557,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *289 - - *290 - - *525 - - *529 + - *294 + - *295 + - *535 + - *539 requestBody: required: true content: @@ -84440,7 +85589,7 @@ paths: description: Response content: application/json: - schema: *528 + schema: *538 examples: default: value: @@ -84503,10 +85652,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *289 - - *290 - - *525 - - *529 + - *294 + - *295 + - *535 + - *539 requestBody: required: true content: @@ -84541,9 +85690,9 @@ paths: description: Response content: application/json: - schema: *528 + schema: *538 examples: - default: *531 + default: *541 '404': *6 '422': *7 '403': *27 @@ -84565,9 +85714,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch parameters: - - *289 - - *290 - - *525 + - *294 + - *295 + - *535 requestBody: required: false content: @@ -84631,8 +85780,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme parameters: - - *289 - - *290 + - *294 + - *295 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -84645,9 +85794,9 @@ paths: description: Response content: application/json: - schema: *532 + schema: *542 examples: - default: &533 + default: &543 value: type: file encoding: base64 @@ -84689,8 +85838,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *289 - - *290 + - *294 + - *295 - name: dir description: The alternate path to look for a README file in: path @@ -84710,9 +85859,9 @@ paths: description: Response content: application/json: - schema: *532 + schema: *542 examples: - default: *533 + default: *543 '404': *6 '422': *15 x-github: @@ -84734,8 +85883,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#list-releases parameters: - - *289 - - *290 + - *294 + - *295 - *17 - *19 responses: @@ -84745,7 +85894,7 @@ paths: application/json: schema: type: array - items: &534 + items: &544 title: Release description: A release. type: object @@ -84822,7 +85971,7 @@ paths: author: *4 assets: type: array - items: &535 + items: &545 title: Release Asset description: Data related to a release. type: object @@ -85009,8 +86158,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#create-a-release parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: @@ -85086,9 +86235,9 @@ paths: description: Response content: application/json: - schema: *534 + schema: *544 examples: - default: &538 + default: &548 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -85193,9 +86342,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#get-a-release-asset parameters: - - *289 - - *290 - - &536 + - *294 + - *295 + - &546 name: asset_id description: The unique identifier of the asset. in: path @@ -85207,9 +86356,9 @@ paths: description: Response content: application/json: - schema: *535 + schema: *545 examples: - default: &537 + default: &547 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 @@ -85244,7 +86393,7 @@ paths: type: User site_admin: false '404': *6 - '302': *431 + '302': *441 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85260,9 +86409,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#update-a-release-asset parameters: - - *289 - - *290 - - *536 + - *294 + - *295 + - *546 requestBody: required: false content: @@ -85291,9 +86440,9 @@ paths: description: Response content: application/json: - schema: *535 + schema: *545 examples: - default: *537 + default: *547 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85309,9 +86458,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#delete-a-release-asset parameters: - - *289 - - *290 - - *536 + - *294 + - *295 + - *546 responses: '204': description: Response @@ -85335,8 +86484,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: @@ -85422,16 +86571,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-the-latest-release parameters: - - *289 - - *290 + - *294 + - *295 responses: '200': description: Response content: application/json: - schema: *534 + schema: *544 examples: - default: *538 + default: *548 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85448,8 +86597,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name parameters: - - *289 - - *290 + - *294 + - *295 - name: tag description: tag parameter in: path @@ -85462,9 +86611,9 @@ paths: description: Response content: application/json: - schema: *534 + schema: *544 examples: - default: *538 + default: *548 '404': *6 x-github: githubCloudOnly: false @@ -85486,9 +86635,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release parameters: - - *289 - - *290 - - &539 + - *294 + - *295 + - &549 name: release_id description: The unique identifier of the release. in: path @@ -85502,9 +86651,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: *534 + schema: *544 examples: - default: *538 + default: *548 '401': description: Unauthorized x-github: @@ -85522,9 +86671,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#update-a-release parameters: - - *289 - - *290 - - *539 + - *294 + - *295 + - *549 requestBody: required: false content: @@ -85588,9 +86737,9 @@ paths: description: Response content: application/json: - schema: *534 + schema: *544 examples: - default: *538 + default: *548 '404': description: Not Found if the discussion category name is invalid content: @@ -85611,9 +86760,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#delete-a-release parameters: - - *289 - - *290 - - *539 + - *294 + - *295 + - *549 responses: '204': description: Response @@ -85633,9 +86782,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#list-release-assets parameters: - - *289 - - *290 - - *539 + - *294 + - *295 + - *549 - *17 - *19 responses: @@ -85645,7 +86794,7 @@ paths: application/json: schema: type: array - items: *535 + items: *545 examples: default: value: @@ -85726,9 +86875,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: - - *289 - - *290 - - *539 + - *294 + - *295 + - *549 - name: name in: query required: true @@ -85754,7 +86903,7 @@ paths: description: Response for successful upload content: application/json: - schema: *535 + schema: *545 examples: response-for-successful-upload: value: @@ -85809,9 +86958,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release parameters: - - *289 - - *290 - - *539 + - *294 + - *295 + - *549 - 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. @@ -85835,9 +86984,9 @@ paths: application/json: schema: type: array - items: *282 + items: *287 examples: - default: *284 + default: *289 headers: Link: *57 '404': *6 @@ -85858,9 +87007,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release parameters: - - *289 - - *290 - - *539 + - *294 + - *295 + - *549 requestBody: required: true content: @@ -85890,16 +87039,16 @@ paths: description: Reaction exists content: application/json: - schema: *282 + schema: *287 examples: - default: *283 + default: *288 '201': description: Reaction created content: application/json: - schema: *282 + schema: *287 examples: - default: *283 + default: *288 '422': *15 x-github: githubCloudOnly: false @@ -85921,10 +87070,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction parameters: - - *289 + - *294 + - *295 + - *549 - *290 - - *539 - - *285 responses: '204': description: Response @@ -85948,9 +87097,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch parameters: - - *289 - - *290 - - *357 + - *294 + - *295 + - *367 - *17 - *19 responses: @@ -85966,8 +87115,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *233 - - &540 + - *236 + - &550 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -85986,66 +87135,66 @@ paths: ruleset_id: type: integer description: The ID of the ruleset that includes this rule. - - allOf: - - *234 - - *540 - - allOf: - - *235 - - *540 - - allOf: - - *236 - - *540 - - allOf: - - *541 - - *540 - allOf: - *237 - - *540 + - *550 - allOf: - *238 - - *540 + - *550 - allOf: - *239 - - *540 + - *550 + - allOf: + - *551 + - *550 - allOf: - *240 - - *540 + - *550 - allOf: - *241 - - *540 + - *550 - allOf: - *242 - - *540 + - *550 - allOf: - *243 - - *540 + - *550 - allOf: - *244 - - *540 + - *550 - allOf: - *245 - - *540 + - *550 - allOf: - *246 - - *540 + - *550 - allOf: - *247 - - *540 + - *550 - allOf: - *248 - - *540 + - *550 - allOf: - *249 - - *540 + - *550 - allOf: - *250 - - *540 + - *550 - allOf: - *251 - - *540 + - *550 - allOf: - *252 - - *540 + - *550 + - allOf: + - *253 + - *550 + - allOf: + - *254 + - *550 + - allOf: + - *255 + - *550 examples: default: value: @@ -86084,8 +87233,8 @@ paths: category: repos subcategory: rules parameters: - - *289 - - *290 + - *294 + - *295 - *17 - *19 - name: includes_parents @@ -86096,7 +87245,7 @@ paths: schema: type: boolean default: true - - *542 + - *552 responses: '200': description: Response @@ -86104,7 +87253,7 @@ paths: application/json: schema: type: array - items: *253 + items: *256 examples: default: value: @@ -86135,7 +87284,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *91 + '500': *94 post: summary: Create a repository ruleset description: Create a ruleset for a repository. @@ -86151,8 +87300,8 @@ paths: category: repos subcategory: rules parameters: - - *289 - - *290 + - *294 + - *295 requestBody: description: Request body required: true @@ -86172,16 +87321,16 @@ paths: - tag - push default: branch - enforcement: *230 + enforcement: *233 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *231 - conditions: *228 + items: *234 + conditions: *231 rules: type: array description: An array of rules within the ruleset. - items: *543 + items: *553 required: - name - enforcement @@ -86212,9 +87361,9 @@ paths: description: Response content: application/json: - schema: *253 + schema: *256 examples: - default: &553 + default: &563 value: id: 42 name: super cool ruleset @@ -86247,7 +87396,7 @@ paths: created_at: '2023-07-15T08:43:03Z' updated_at: '2023-08-23T16:29:47Z' '404': *6 - '500': *91 + '500': *94 "/repos/{owner}/{repo}/rulesets/rule-suites": get: summary: List repository rule suites @@ -86261,12 +87410,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites parameters: - - *289 - - *290 - - *544 - - *545 - - *546 - - *547 + - *294 + - *295 + - *554 + - *555 + - *556 + - *557 - *17 - *19 responses: @@ -86274,11 +87423,11 @@ paths: description: Response content: application/json: - schema: *548 + schema: *558 examples: - default: *549 + default: *559 '404': *6 - '500': *91 + '500': *94 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86297,19 +87446,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *289 - - *290 - - *550 + - *294 + - *295 + - *560 responses: '200': description: Response content: application/json: - schema: *551 + schema: *561 examples: - default: *552 + default: *562 '404': *6 - '500': *91 + '500': *94 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86335,8 +87484,8 @@ paths: category: repos subcategory: rules parameters: - - *289 - - *290 + - *294 + - *295 - name: ruleset_id description: The ID of the ruleset. in: path @@ -86356,11 +87505,11 @@ paths: description: Response content: application/json: - schema: *253 + schema: *256 examples: - default: *553 + default: *563 '404': *6 - '500': *91 + '500': *94 put: summary: Update a repository ruleset description: Update a ruleset for a repository. @@ -86376,8 +87525,8 @@ paths: category: repos subcategory: rules parameters: - - *289 - - *290 + - *294 + - *295 - name: ruleset_id description: The ID of the ruleset. in: path @@ -86402,16 +87551,16 @@ paths: - branch - tag - push - enforcement: *230 + enforcement: *233 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *231 - conditions: *228 + items: *234 + conditions: *231 rules: description: An array of rules within the ruleset. type: array - items: *543 + items: *553 examples: default: value: @@ -86439,11 +87588,11 @@ paths: description: Response content: application/json: - schema: *253 + schema: *256 examples: - default: *553 + default: *563 '404': *6 - '500': *91 + '500': *94 delete: summary: Delete a repository ruleset description: Delete a ruleset for a repository. @@ -86459,8 +87608,8 @@ paths: category: repos subcategory: rules parameters: - - *289 - - *290 + - *294 + - *295 - name: ruleset_id description: The ID of the ruleset. in: path @@ -86471,7 +87620,7 @@ paths: '204': description: Response '404': *6 - '500': *91 + '500': *94 "/repos/{owner}/{repo}/rulesets/{ruleset_id}/history": get: summary: Get repository ruleset history @@ -86483,8 +87632,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history parameters: - - *289 - - *290 + - *294 + - *295 - *17 - *19 - name: ruleset_id @@ -86500,11 +87649,11 @@ paths: application/json: schema: type: array - items: *256 + items: *259 examples: - default: *554 + default: *564 '404': *6 - '500': *91 + '500': *94 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86521,8 +87670,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version parameters: - - *289 - - *290 + - *294 + - *295 - name: ruleset_id description: The ID of the ruleset. in: path @@ -86540,7 +87689,7 @@ paths: description: Response content: application/json: - schema: *555 + schema: *565 examples: default: value: @@ -86573,7 +87722,7 @@ paths: operator: contains pattern: github '404': *6 - '500': *91 + '500': *94 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86595,21 +87744,21 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *289 - - *290 - - *257 - - *258 - - *259 + - *294 + - *295 - *260 - - *46 - - *19 - - *17 - - *556 - - *557 - *261 - *262 - *263 + - *46 + - *19 + - *17 + - *566 + - *567 - *264 + - *265 + - *266 + - *267 responses: '200': description: Response @@ -86617,7 +87766,7 @@ paths: application/json: schema: type: array - items: &561 + items: &571 type: object properties: number: *52 @@ -86633,8 +87782,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *558 - resolution: *559 + state: *568 + resolution: *569 resolved_at: type: - string @@ -86728,7 +87877,7 @@ paths: first_location_detected: anyOf: - type: 'null' - - *560 + - *570 has_more_locations: type: boolean description: A boolean value representing whether or not the @@ -86877,16 +88026,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *289 - - *290 - - *388 - - *264 + - *294 + - *295 + - *398 + - *267 responses: '200': description: Response content: application/json: - schema: *561 + schema: *571 examples: default: value: @@ -86938,9 +88087,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *289 - - *290 - - *388 + - *294 + - *295 + - *398 requestBody: required: true content: @@ -86948,8 +88097,8 @@ paths: schema: type: object properties: - state: *558 - resolution: *559 + state: *568 + resolution: *569 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -86968,7 +88117,7 @@ paths: description: Response content: application/json: - schema: *561 + schema: *571 examples: default: value: @@ -87043,9 +88192,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *289 - - *290 - - *388 + - *294 + - *295 + - *398 - *19 - *17 responses: @@ -87056,7 +88205,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &711 + items: &721 type: object properties: type: @@ -87083,19 +88232,19 @@ paths: - commit details: oneOf: - - *562 - - *563 - - *564 - - *565 - - *566 - - *567 - - *568 - - *569 - - *570 - - *571 - *572 - *573 - *574 + - *575 + - *576 + - *577 + - *578 + - *579 + - *580 + - *581 + - *582 + - *583 + - *584 examples: default: value: @@ -87181,8 +88330,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: @@ -87190,14 +88339,14 @@ paths: schema: type: object properties: - reason: &576 + reason: &586 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *575 + placeholder_id: *585 required: - reason - placeholder_id @@ -87214,7 +88363,7 @@ paths: schema: type: object properties: - reason: *576 + reason: *586 expire_at: type: - string @@ -87258,8 +88407,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: - - *289 - - *290 + - *294 + - *295 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -87274,7 +88423,7 @@ paths: properties: incremental_scans: type: array - items: &577 + items: &587 description: Information on a single scan performed by secret scanning on the repository type: object @@ -87302,15 +88451,15 @@ paths: the scan is pending pattern_update_scans: type: array - items: *577 + items: *587 backfill_scans: type: array - items: *577 + items: *587 custom_pattern_backfill_scans: type: array items: allOf: - - *577 + - *587 - type: object properties: pattern_name: @@ -87380,8 +88529,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *289 - - *290 + - *294 + - *295 - *46 - name: sort description: The property to sort the results by. @@ -87425,9 +88574,9 @@ paths: application/json: schema: type: array - items: *578 + items: *588 examples: - default: *579 + default: *589 '400': *14 '404': *6 x-github: @@ -87450,8 +88599,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: @@ -87531,7 +88680,7 @@ paths: login: type: string description: The username of the user credited. - type: *267 + type: *272 required: - login - type @@ -87621,9 +88770,9 @@ paths: description: Response content: application/json: - schema: *578 + schema: *588 examples: - default: &581 + default: &591 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -87856,8 +89005,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: @@ -87970,7 +89119,7 @@ paths: description: Response content: application/json: - schema: *578 + schema: *588 examples: default: value: @@ -88117,17 +89266,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *289 - - *290 - - *580 + - *294 + - *295 + - *590 responses: '200': description: Response content: application/json: - schema: *578 + schema: *588 examples: - default: *581 + default: *591 '403': *27 '404': *6 x-github: @@ -88151,9 +89300,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *289 - - *290 - - *580 + - *294 + - *295 + - *590 requestBody: required: true content: @@ -88233,7 +89382,7 @@ paths: login: type: string description: The username of the user credited. - type: *267 + type: *272 required: - login - type @@ -88324,17 +89473,17 @@ paths: description: Response content: application/json: - schema: *578 + schema: *588 examples: - default: *581 - add_credit: *581 + default: *591 + add_credit: *591 '403': *27 '404': *6 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *94 + schema: *97 examples: invalid_state_transition: value: @@ -88365,9 +89514,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: - - *289 - - *290 - - *580 + - *294 + - *295 + - *590 responses: '202': *37 '400': *14 @@ -88394,17 +89543,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *289 - - *290 - - *580 + - *294 + - *295 + - *590 responses: '202': description: Response content: application/json: - schema: *300 + schema: *305 examples: - default: *302 + default: *307 '400': *14 '422': *15 '403': *27 @@ -88430,8 +89579,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-stargazers parameters: - - *289 - - *290 + - *294 + - *295 - *17 - *19 responses: @@ -88527,8 +89676,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *289 - - *290 + - *294 + - *295 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -88537,7 +89686,7 @@ paths: application/json: schema: type: array - items: &582 + items: &592 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -88550,7 +89699,7 @@ paths: - 1124 - -435 '202': *37 - '204': *142 + '204': *145 '422': description: Repository contains more than 10,000 commits x-github: @@ -88570,8 +89719,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *289 - - *290 + - *294 + - *295 responses: '200': description: Response @@ -88622,7 +89771,7 @@ paths: total: 89 week: 1336280400 '202': *37 - '204': *142 + '204': *145 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88649,8 +89798,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *289 - - *290 + - *294 + - *295 responses: '200': description: Response @@ -88722,7 +89871,7 @@ paths: d: 77 c: 10 '202': *37 - '204': *142 + '204': *145 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88744,8 +89893,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *289 - - *290 + - *294 + - *295 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -88899,8 +90048,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *289 - - *290 + - *294 + - *295 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -88910,7 +90059,7 @@ paths: application/json: schema: type: array - items: *582 + items: *592 examples: default: value: @@ -88923,7 +90072,7 @@ paths: - - 0 - 2 - 21 - '204': *142 + '204': *145 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88943,8 +90092,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#create-a-commit-status parameters: - - *289 - - *290 + - *294 + - *295 - name: sha in: path required: true @@ -89000,7 +90149,7 @@ paths: description: Response content: application/json: - schema: *583 + schema: *593 examples: default: value: @@ -89054,8 +90203,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-watchers parameters: - - *289 - - *290 + - *294 + - *295 - *17 - *19 responses: @@ -89067,7 +90216,7 @@ paths: type: array items: *4 examples: - default: *191 + default: *194 headers: Link: *57 x-github: @@ -89087,14 +90236,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription parameters: - - *289 - - *290 + - *294 + - *295 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &584 + schema: &594 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -89167,8 +90316,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: false content: @@ -89194,7 +90343,7 @@ paths: description: Response content: application/json: - schema: *584 + schema: *594 examples: default: value: @@ -89221,8 +90370,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription parameters: - - *289 - - *290 + - *294 + - *295 responses: '204': description: Response @@ -89242,8 +90391,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-tags parameters: - - *289 - - *290 + - *294 + - *295 - *17 - *19 responses: @@ -89325,8 +90474,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository parameters: - - *289 - - *290 + - *294 + - *295 responses: '200': description: Response @@ -89334,7 +90483,7 @@ paths: application/json: schema: type: array - items: &585 + items: &595 title: Tag protection description: Tag protection type: object @@ -89391,8 +90540,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: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: @@ -89415,7 +90564,7 @@ paths: description: Response content: application/json: - schema: *585 + schema: *595 examples: default: value: @@ -89446,8 +90595,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: - - *289 - - *290 + - *294 + - *295 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -89484,8 +90633,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *289 - - *290 + - *294 + - *295 - name: ref in: path required: true @@ -89521,8 +90670,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-teams parameters: - - *289 - - *290 + - *294 + - *295 - *17 - *19 responses: @@ -89532,9 +90681,9 @@ paths: application/json: schema: type: array - items: *147 + items: *150 examples: - default: *204 + default: *207 headers: Link: *57 '404': *6 @@ -89554,8 +90703,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-all-repository-topics parameters: - - *289 - - *290 + - *294 + - *295 - *19 - *17 responses: @@ -89563,7 +90712,7 @@ paths: description: Response content: application/json: - schema: &586 + schema: &596 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -89575,7 +90724,7 @@ paths: required: - names examples: - default: &587 + default: &597 value: names: - octocat @@ -89598,8 +90747,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: @@ -89630,9 +90779,9 @@ paths: description: Response content: application/json: - schema: *586 + schema: *596 examples: - default: *587 + default: *597 '404': *6 '422': *7 x-github: @@ -89653,9 +90802,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-repository-clones parameters: - - *289 - - *290 - - &588 + - *294 + - *295 + - &598 name: per description: The time frame to display results for. in: query @@ -89686,7 +90835,7 @@ paths: - 128 clones: type: array - items: &589 + items: &599 title: Traffic type: object properties: @@ -89773,8 +90922,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths parameters: - - *289 - - *290 + - *294 + - *295 responses: '200': description: Response @@ -89868,8 +91017,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources parameters: - - *289 - - *290 + - *294 + - *295 responses: '200': description: Response @@ -89932,9 +91081,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-page-views parameters: - - *289 - - *290 - - *588 + - *294 + - *295 + - *598 responses: '200': description: Response @@ -89955,7 +91104,7 @@ paths: - 3782 views: type: array - items: *589 + items: *599 required: - uniques - count @@ -90032,8 +91181,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#transfer-a-repository parameters: - - *289 - - *290 + - *294 + - *295 requestBody: required: true content: @@ -90069,7 +91218,7 @@ paths: description: Response content: application/json: - schema: *116 + schema: *119 examples: default: value: @@ -90307,8 +91456,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *289 - - *290 + - *294 + - *295 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -90331,8 +91480,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts parameters: - - *289 - - *290 + - *294 + - *295 responses: '204': description: Response @@ -90354,8 +91503,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts parameters: - - *289 - - *290 + - *294 + - *295 responses: '204': description: Response @@ -90381,8 +91530,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *289 - - *290 + - *294 + - *295 - name: ref in: path required: true @@ -90474,9 +91623,9 @@ paths: description: Response content: application/json: - schema: *300 + schema: *305 examples: - default: *302 + default: *307 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -90517,7 +91666,7 @@ paths: application/json: schema: type: array - items: *116 + items: *119 examples: default: value: @@ -90706,7 +91855,7 @@ paths: html_url: type: string format: uri - repository: *116 + repository: *119 score: type: number file_size: @@ -90725,7 +91874,7 @@ paths: examples: - 73..77 - 77..78 - text_matches: &590 + text_matches: &600 title: Search Result Text Matches type: array items: @@ -90888,7 +92037,7 @@ paths: enum: - author-date - committer-date - - &591 + - &601 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 @@ -90957,7 +92106,7 @@ paths: committer: anyOf: - type: 'null' - - *355 + - *365 comment_count: type: integer message: @@ -90976,7 +92125,7 @@ paths: url: type: string format: uri - verification: *466 + verification: *476 required: - author - committer @@ -90991,7 +92140,7 @@ paths: committer: anyOf: - type: 'null' - - *355 + - *365 parents: type: array items: @@ -91003,12 +92152,12 @@ paths: type: string sha: type: string - repository: *116 + repository: *119 score: type: number node_id: type: string - text_matches: *590 + text_matches: *600 required: - sha - node_id @@ -91190,7 +92339,7 @@ paths: - interactions - created - updated - - *591 + - *601 - *17 - *19 - name: advanced_search @@ -91287,7 +92436,8 @@ paths: type: - string - 'null' - sub_issues_summary: *592 + sub_issues_summary: *602 + issue_dependencies_summary: *603 state: type: string state_reason: @@ -91301,7 +92451,7 @@ paths: milestone: anyOf: - type: 'null' - - *421 + - *431 comments: type: integer created_at: @@ -91315,7 +92465,7 @@ paths: - string - 'null' format: date-time - text_matches: *590 + text_matches: *600 pull_request: type: object properties: @@ -91364,7 +92514,7 @@ paths: timeline_url: type: string format: uri - type: *186 + type: *189 performed_via_github_app: anyOf: - type: 'null' @@ -91541,7 +92691,7 @@ paths: enum: - created - updated - - *591 + - *601 - *17 - *19 responses: @@ -91586,7 +92736,7 @@ paths: - 'null' score: type: number - text_matches: *590 + text_matches: *600 required: - id - node_id @@ -91671,7 +92821,7 @@ paths: - forks - help-wanted-issues - updated - - *591 + - *601 - *17 - *19 responses: @@ -91908,7 +93058,7 @@ paths: - admin - pull - push - text_matches: *590 + text_matches: *600 temp_clone_token: type: string allow_merge_commit: @@ -92216,7 +93366,7 @@ paths: - string - 'null' format: uri - text_matches: *590 + text_matches: *600 related: type: - array @@ -92409,7 +93559,7 @@ paths: - followers - repositories - joined - - *591 + - *601 - *17 - *19 responses: @@ -92519,7 +93669,7 @@ paths: type: - boolean - 'null' - text_matches: *590 + text_matches: *600 blog: type: - string @@ -92601,7 +93751,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &593 + - &604 name: team_id description: The unique identifier of the team. in: path @@ -92613,9 +93763,9 @@ paths: description: Response content: application/json: - schema: *274 + schema: *279 examples: - default: *275 + default: *280 '404': *6 x-github: githubCloudOnly: false @@ -92642,7 +93792,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *593 + - *604 requestBody: required: true content: @@ -92706,16 +93856,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *274 + schema: *279 examples: - default: *275 + default: *280 '201': description: Response content: application/json: - schema: *274 + schema: *279 examples: - default: *275 + default: *280 '404': *6 '422': *15 '403': *27 @@ -92743,7 +93893,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *593 + - *604 responses: '204': description: Response @@ -92774,7 +93924,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions-legacy parameters: - - *593 + - *604 - *46 - *17 - *19 @@ -92785,9 +93935,9 @@ paths: application/json: schema: type: array - items: *276 + items: *281 examples: - default: *594 + default: *605 headers: Link: *57 x-github: @@ -92816,7 +93966,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy parameters: - - *593 + - *604 requestBody: required: true content: @@ -92850,9 +94000,9 @@ paths: description: Response content: application/json: - schema: *276 + schema: *281 examples: - default: *277 + default: *282 x-github: triggersNotification: true githubCloudOnly: false @@ -92879,16 +94029,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy parameters: - - *593 - - *278 + - *604 + - *283 responses: '200': description: Response content: application/json: - schema: *276 + schema: *281 examples: - default: *277 + default: *282 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92913,8 +94063,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy parameters: - - *593 - - *278 + - *604 + - *283 requestBody: required: false content: @@ -92937,9 +94087,9 @@ paths: description: Response content: application/json: - schema: *276 + schema: *281 examples: - default: *595 + default: *606 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92964,8 +94114,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy parameters: - - *593 - - *278 + - *604 + - *283 responses: '204': description: Response @@ -92994,8 +94144,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *593 - - *278 + - *604 + - *283 - *46 - *17 - *19 @@ -93006,9 +94156,9 @@ paths: application/json: schema: type: array - items: *279 + items: *284 examples: - default: *596 + default: *607 headers: Link: *57 x-github: @@ -93037,8 +94187,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *593 - - *278 + - *604 + - *283 requestBody: required: true content: @@ -93060,9 +94210,9 @@ paths: description: Response content: application/json: - schema: *279 + schema: *284 examples: - default: *280 + default: *285 x-github: triggersNotification: true githubCloudOnly: false @@ -93089,17 +94239,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *593 - - *278 - - *281 + - *604 + - *283 + - *286 responses: '200': description: Response content: application/json: - schema: *279 + schema: *284 examples: - default: *280 + default: *285 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93124,9 +94274,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *593 - - *278 - - *281 + - *604 + - *283 + - *286 requestBody: required: true content: @@ -93148,9 +94298,9 @@ paths: description: Response content: application/json: - schema: *279 + schema: *284 examples: - default: *597 + default: *608 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93175,9 +94325,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *593 - - *278 - - *281 + - *604 + - *283 + - *286 responses: '204': description: Response @@ -93206,9 +94356,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - - *593 - - *278 - - *281 + - *604 + - *283 + - *286 - 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. @@ -93234,9 +94384,9 @@ paths: application/json: schema: type: array - items: *282 + items: *287 examples: - default: *284 + default: *289 headers: Link: *57 x-github: @@ -93265,9 +94415,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - - *593 - - *278 - - *281 + - *604 + - *283 + - *286 requestBody: required: true content: @@ -93299,9 +94449,9 @@ paths: description: Response content: application/json: - schema: *282 + schema: *287 examples: - default: *283 + default: *288 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93327,8 +94477,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - - *593 - - *278 + - *604 + - *283 - 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. @@ -93354,9 +94504,9 @@ paths: application/json: schema: type: array - items: *282 + items: *287 examples: - default: *284 + default: *289 headers: Link: *57 x-github: @@ -93385,8 +94535,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - - *593 - - *278 + - *604 + - *283 requestBody: required: true content: @@ -93418,9 +94568,9 @@ paths: description: Response content: application/json: - schema: *282 + schema: *287 examples: - default: *283 + default: *288 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -93444,7 +94594,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *593 + - *604 - *17 - *19 responses: @@ -93454,9 +94604,9 @@ paths: application/json: schema: type: array - items: *183 + items: *186 examples: - default: *184 + default: *187 headers: Link: *57 x-github: @@ -93482,7 +94632,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *593 + - *604 - name: role description: Filters members returned by their role in the team. in: query @@ -93505,7 +94655,7 @@ paths: type: array items: *4 examples: - default: *191 + default: *194 headers: Link: *57 '404': *6 @@ -93533,8 +94683,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *593 - - *129 + - *604 + - *132 responses: '204': description: if user is a member @@ -93570,8 +94720,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *593 - - *129 + - *604 + - *132 responses: '204': description: Response @@ -93610,8 +94760,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *593 - - *129 + - *604 + - *132 responses: '204': description: Response @@ -93647,16 +94797,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *593 - - *129 + - *604 + - *132 responses: '200': description: Response content: application/json: - schema: *286 + schema: *291 examples: - response-if-user-is-a-team-maintainer: *598 + response-if-user-is-a-team-maintainer: *609 '404': *6 x-github: githubCloudOnly: false @@ -93689,8 +94839,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *593 - - *129 + - *604 + - *132 requestBody: required: false content: @@ -93715,9 +94865,9 @@ paths: description: Response content: application/json: - schema: *286 + schema: *291 examples: - response-if-users-membership-with-team-is-now-pending: *599 + response-if-users-membership-with-team-is-now-pending: *610 '403': description: Forbidden if team synchronization is set up '422': @@ -93751,8 +94901,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *593 - - *129 + - *604 + - *132 responses: '204': description: Response @@ -93780,7 +94930,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-projects-legacy parameters: - - *593 + - *604 - *17 - *19 responses: @@ -93790,9 +94940,9 @@ paths: application/json: schema: type: array - items: *287 + items: *292 examples: - default: *600 + default: *611 headers: Link: *57 '404': *6 @@ -93818,16 +94968,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy parameters: - - *593 - - *288 + - *604 + - *293 responses: '200': description: Response content: application/json: - schema: *287 + schema: *292 examples: - default: *601 + default: *612 '404': description: Not Found if project is not managed by this team x-github: @@ -93851,8 +95001,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy parameters: - - *593 - - *288 + - *604 + - *293 requestBody: required: false content: @@ -93919,8 +95069,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy parameters: - - *593 - - *288 + - *604 + - *293 responses: '204': description: Response @@ -93947,7 +95097,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *593 + - *604 - *17 - *19 responses: @@ -93957,9 +95107,9 @@ paths: application/json: schema: type: array - items: *116 + items: *119 examples: - default: *211 + default: *214 headers: Link: *57 '404': *6 @@ -93989,15 +95139,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *593 - - *289 - - *290 + - *604 + - *294 + - *295 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *602 + schema: *613 examples: alternative-response-with-extra-repository-information: value: @@ -94148,9 +95298,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *593 - - *289 - - *290 + - *604 + - *294 + - *295 requestBody: required: false content: @@ -94200,9 +95350,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *593 - - *289 - - *290 + - *604 + - *294 + - *295 responses: '204': description: Response @@ -94227,7 +95377,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *593 + - *604 - *17 - *19 responses: @@ -94237,9 +95387,9 @@ paths: application/json: schema: type: array - items: *147 + items: *150 examples: - response-if-child-teams-exist: *603 + response-if-child-teams-exist: *614 headers: Link: *57 '404': *6 @@ -94272,7 +95422,7 @@ paths: application/json: schema: oneOf: - - &605 + - &616 title: Private User description: Private User type: object @@ -94522,7 +95672,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *604 + - *615 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -94682,7 +95832,7 @@ paths: description: Response content: application/json: - schema: *605 + schema: *616 examples: default: value: @@ -94761,7 +95911,7 @@ paths: type: array items: *4 examples: - default: *191 + default: *194 '304': *35 '404': *6 '403': *27 @@ -94784,7 +95934,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: - - *129 + - *132 responses: '204': description: If the user is blocked @@ -94812,7 +95962,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#block-a-user parameters: - - *129 + - *132 responses: '204': description: Response @@ -94836,7 +95986,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#unblock-a-user parameters: - - *129 + - *132 responses: '204': description: Response @@ -94885,11 +96035,11 @@ paths: type: integer codespaces: type: array - items: *192 + items: *195 examples: - default: *193 + default: *196 '304': *35 - '500': *91 + '500': *94 '401': *23 '403': *27 '404': *6 @@ -95026,17 +96176,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *192 + schema: *195 examples: - default: *408 + default: *418 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *192 + schema: *195 examples: - default: *408 + default: *418 '401': *23 '403': *27 '404': *6 @@ -95080,7 +96230,7 @@ paths: type: integer secrets: type: array - items: &606 + items: &617 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -95122,7 +96272,7 @@ paths: - visibility - selected_repositories_url examples: - default: *410 + default: *420 headers: Link: *57 x-github: @@ -95194,13 +96344,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user parameters: - - *124 + - *127 responses: '200': description: Response content: application/json: - schema: *606 + schema: *617 examples: default: value: @@ -95230,7 +96380,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user parameters: - - *124 + - *127 requestBody: required: true content: @@ -95275,7 +96425,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *125 + schema: *128 examples: default: value: @@ -95303,7 +96453,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user parameters: - - *124 + - *127 responses: '204': description: Response @@ -95328,7 +96478,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret parameters: - - *124 + - *127 responses: '200': description: Response @@ -95344,13 +96494,13 @@ paths: type: integer repositories: type: array - items: *116 + items: *119 examples: - default: *607 + default: *618 '401': *23 '403': *27 '404': *6 - '500': *91 + '500': *94 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -95371,7 +96521,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret parameters: - - *124 + - *127 requestBody: required: true content: @@ -95403,7 +96553,7 @@ paths: '401': *23 '403': *27 '404': *6 - '500': *91 + '500': *94 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -95425,7 +96575,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret parameters: - - *124 + - *127 - name: repository_id in: path required: true @@ -95437,7 +96587,7 @@ paths: '401': *23 '403': *27 '404': *6 - '500': *91 + '500': *94 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -95458,7 +96608,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret parameters: - - *124 + - *127 - name: repository_id in: path required: true @@ -95470,7 +96620,7 @@ paths: '401': *23 '403': *27 '404': *6 - '500': *91 + '500': *94 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -95490,17 +96640,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *194 + - *197 responses: '200': description: Response content: application/json: - schema: *192 + schema: *195 examples: - default: *408 + default: *418 '304': *35 - '500': *91 + '500': *94 '401': *23 '403': *27 '404': *6 @@ -95524,7 +96674,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *194 + - *197 requestBody: required: false content: @@ -95554,9 +96704,9 @@ paths: description: Response content: application/json: - schema: *192 + schema: *195 examples: - default: *408 + default: *418 '401': *23 '403': *27 '404': *6 @@ -95578,11 +96728,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *194 + - *197 responses: '202': *37 '304': *35 - '500': *91 + '500': *94 '401': *23 '403': *27 '404': *6 @@ -95607,13 +96757,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *194 + - *197 responses: '202': description: Response content: application/json: - schema: &608 + schema: &619 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -95666,7 +96816,7 @@ paths: examples: - https://github.com/octocat/hello-world/tree/:branch examples: - default: &609 + default: &620 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -95674,7 +96824,7 @@ paths: sha: fd95a81ca01e48ede9f39c799ecbcef817b8a3b2 id: latest export_url: https://api.github.com/user/codespaces/:name/exports/latest - '500': *91 + '500': *94 '401': *23 '403': *27 '404': *6 @@ -95698,7 +96848,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *194 + - *197 - name: export_id in: path required: true @@ -95711,9 +96861,9 @@ paths: description: Response content: application/json: - schema: *608 + schema: *619 examples: - default: *609 + default: *620 '404': *6 x-github: githubCloudOnly: false @@ -95734,7 +96884,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *194 + - *197 responses: '200': description: Response @@ -95750,11 +96900,11 @@ paths: type: integer machines: type: array - items: *409 + items: *419 examples: - default: *610 + default: *621 '304': *35 - '500': *91 + '500': *94 '401': *23 '403': *27 '404': *6 @@ -95781,7 +96931,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *194 + - *197 requestBody: required: true content: @@ -95837,11 +96987,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *300 + repository: *305 machine: anyOf: - type: 'null' - - *409 + - *419 devcontainer_path: description: Path to devcontainer.json from repo root used to create Codespace. @@ -96638,17 +97788,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *194 + - *197 responses: '200': description: Response content: application/json: - schema: *192 + schema: *195 examples: - default: *408 + default: *418 '304': *35 - '500': *91 + '500': *94 '400': *14 '401': *23 '402': @@ -96678,16 +97828,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *194 + - *197 responses: '200': description: Response content: application/json: - schema: *192 + schema: *195 examples: - default: *408 - '500': *91 + default: *418 + '500': *94 '401': *23 '403': *27 '404': *6 @@ -96716,9 +97866,9 @@ paths: application/json: schema: type: array - items: *205 + items: *208 examples: - default: &623 + default: &633 value: - id: 197 name: hello_docker @@ -96819,7 +97969,7 @@ paths: application/json: schema: type: array - items: &611 + items: &622 title: Email description: Email type: object @@ -96889,9 +98039,9 @@ paths: application/json: schema: type: array - items: *611 + items: *622 examples: - default: &625 + default: &635 value: - email: octocat@github.com verified: true @@ -96968,7 +98118,7 @@ paths: application/json: schema: type: array - items: *611 + items: *622 examples: default: value: @@ -97080,7 +98230,7 @@ paths: type: array items: *4 examples: - default: *191 + default: *194 headers: Link: *57 '304': *35 @@ -97113,7 +98263,7 @@ paths: type: array items: *4 examples: - default: *191 + default: *194 headers: Link: *57 '304': *35 @@ -97135,7 +98285,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: - - *129 + - *132 responses: '204': description: if the person is followed by the authenticated user @@ -97165,7 +98315,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#follow-a-user parameters: - - *129 + - *132 responses: '204': description: Response @@ -97190,7 +98340,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#unfollow-a-user parameters: - - *129 + - *132 responses: '204': description: Response @@ -97226,7 +98376,7 @@ paths: application/json: schema: type: array - items: &612 + items: &623 title: GPG Key description: A unique encryption key type: object @@ -97371,7 +98521,7 @@ paths: - subkeys - revoked examples: - default: &639 + default: &649 value: - id: 3 name: Octocat's GPG Key @@ -97456,9 +98606,9 @@ paths: description: Response content: application/json: - schema: *612 + schema: *623 examples: - default: &613 + default: &624 value: id: 3 name: Octocat's GPG Key @@ -97515,7 +98665,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &614 + - &625 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -97527,9 +98677,9 @@ paths: description: Response content: application/json: - schema: *612 + schema: *623 examples: - default: *613 + default: *624 '404': *6 '304': *35 '403': *27 @@ -97552,7 +98702,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *614 + - *625 responses: '204': description: Response @@ -97743,7 +98893,7 @@ paths: type: array items: *59 examples: - default: *615 + default: *109 headers: Link: *57 '404': *6 @@ -97768,7 +98918,7 @@ paths: url: https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *21 - - *106 + - *93 responses: '204': description: Response @@ -97794,7 +98944,7 @@ paths: url: https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *21 - - *106 + - *93 responses: '204': description: Response @@ -97828,12 +98978,12 @@ paths: application/json: schema: anyOf: - - *181 + - *184 - type: object properties: {} additionalProperties: false examples: - default: *182 + default: *185 '204': description: Response when there are no restrictions x-github: @@ -97857,7 +99007,7 @@ paths: required: true content: application/json: - schema: *477 + schema: *487 examples: default: value: @@ -97868,7 +99018,7 @@ paths: description: Response content: application/json: - schema: *181 + schema: *184 examples: default: value: @@ -97949,7 +99099,7 @@ paths: - closed - all default: open - - *189 + - *192 - name: sort description: What to sort results by. in: query @@ -97974,7 +99124,7 @@ paths: type: array items: *74 examples: - default: *190 + default: *193 headers: Link: *57 '404': *6 @@ -98007,7 +99157,7 @@ paths: application/json: schema: type: array - items: &616 + items: &626 title: Key description: Key type: object @@ -98110,9 +99260,9 @@ paths: description: Response content: application/json: - schema: *616 + schema: *626 examples: - default: &617 + default: &627 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -98145,15 +99295,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *504 + - *514 responses: '200': description: Response content: application/json: - schema: *616 + schema: *626 examples: - default: *617 + default: *627 '404': *6 '304': *35 '403': *27 @@ -98176,7 +99326,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *504 + - *514 responses: '204': description: Response @@ -98209,7 +99359,7 @@ paths: application/json: schema: type: array - items: &618 + items: &628 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -98288,7 +99438,7 @@ paths: - account - plan examples: - default: &619 + default: &629 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -98350,9 +99500,9 @@ paths: application/json: schema: type: array - items: *618 + items: *628 examples: - default: *619 + default: *629 headers: Link: *57 '304': *35 @@ -98392,7 +99542,7 @@ paths: application/json: schema: type: array - items: *196 + items: *199 examples: default: value: @@ -98500,7 +99650,7 @@ paths: description: Response content: application/json: - schema: *196 + schema: *199 examples: default: value: @@ -98583,7 +99733,7 @@ paths: description: Response content: application/json: - schema: *196 + schema: *199 examples: default: value: @@ -98651,7 +99801,7 @@ paths: application/json: schema: type: array - items: *198 + items: *201 examples: default: value: @@ -98913,7 +100063,7 @@ paths: description: Response content: application/json: - schema: *198 + schema: *201 examples: default: value: @@ -99093,7 +100243,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#get-a-user-migration-status parameters: - - *199 + - *202 - name: exclude in: query required: false @@ -99106,7 +100256,7 @@ paths: description: Response content: application/json: - schema: *198 + schema: *201 examples: default: value: @@ -99300,7 +100450,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#download-a-user-migration-archive parameters: - - *199 + - *202 responses: '302': description: Response @@ -99326,7 +100476,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#delete-a-user-migration-archive parameters: - - *199 + - *202 responses: '204': description: Response @@ -99355,8 +100505,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - - *199 - - *620 + - *202 + - *630 responses: '204': description: Response @@ -99380,7 +100530,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *199 + - *202 - *17 - *19 responses: @@ -99390,9 +100540,9 @@ paths: application/json: schema: type: array - items: *116 + items: *119 examples: - default: *211 + default: *214 headers: Link: *57 '404': *6 @@ -99427,9 +100577,9 @@ paths: application/json: schema: type: array - items: *146 + items: *149 examples: - default: *621 + default: *631 headers: Link: *57 '304': *35 @@ -99471,7 +100621,7 @@ paths: - docker - nuget - container - - *622 + - *632 - *19 - *17 responses: @@ -99481,10 +100631,10 @@ paths: application/json: schema: type: array - items: *205 + items: *208 examples: - default: *623 - '400': *624 + default: *633 + '400': *634 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -99504,16 +100654,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user parameters: - - *207 - - *208 + - *210 + - *211 responses: '200': description: Response content: application/json: - schema: *205 + schema: *208 examples: - default: &640 + default: &650 value: id: 40201 name: octo-name @@ -99626,8 +100776,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: - - *207 - - *208 + - *210 + - *211 responses: '204': description: Response @@ -99657,8 +100807,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: - - *207 - - *208 + - *210 + - *211 - name: token description: package token schema: @@ -99690,8 +100840,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: - - *207 - - *208 + - *210 + - *211 - *19 - *17 - name: state @@ -99711,7 +100861,7 @@ paths: application/json: schema: type: array - items: *209 + items: *212 examples: default: value: @@ -99760,15 +100910,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: - - *207 - - *208 - *210 + - *211 + - *213 responses: '200': description: Response content: application/json: - schema: *209 + schema: *212 examples: default: value: @@ -99804,9 +100954,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: - - *207 - - *208 - *210 + - *211 + - *213 responses: '204': description: Response @@ -99836,9 +100986,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: - - *207 - - *208 - *210 + - *211 + - *213 responses: '204': description: Response @@ -99896,7 +101046,7 @@ paths: description: Response content: application/json: - schema: *221 + schema: *224 examples: default: value: @@ -99968,9 +101118,9 @@ paths: application/json: schema: type: array - items: *611 + items: *622 examples: - default: *625 + default: *635 headers: Link: *57 '304': *35 @@ -100083,7 +101233,7 @@ paths: type: array items: *59 examples: - default: &632 + default: &642 summary: Default response value: - id: 1296269 @@ -100401,9 +101551,9 @@ paths: description: Response content: application/json: - schema: *300 + schema: *305 examples: - default: *302 + default: *307 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -100441,9 +101591,9 @@ paths: application/json: schema: type: array - items: *479 + items: *489 examples: - default: *626 + default: *636 headers: Link: *57 '304': *35 @@ -100466,7 +101616,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *185 + - *188 responses: '204': description: Response @@ -100489,7 +101639,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *185 + - *188 responses: '204': description: Response @@ -100522,7 +101672,7 @@ paths: application/json: schema: type: array - items: &627 + items: &637 title: Social account description: Social media account type: object @@ -100539,7 +101689,7 @@ paths: - provider - url examples: - default: &628 + default: &638 value: - provider: twitter url: https://twitter.com/github @@ -100602,9 +101752,9 @@ paths: application/json: schema: type: array - items: *627 + items: *637 examples: - default: *628 + default: *638 '422': *15 '304': *35 '404': *6 @@ -100692,7 +101842,7 @@ paths: application/json: schema: type: array - items: &629 + items: &639 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -100712,7 +101862,7 @@ paths: - title - created_at examples: - default: &651 + default: &661 value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -100779,9 +101929,9 @@ paths: description: Response content: application/json: - schema: *629 + schema: *639 examples: - default: &630 + default: &640 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -100812,7 +101962,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: - - &631 + - &641 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -100824,9 +101974,9 @@ paths: description: Response content: application/json: - schema: *629 + schema: *639 examples: - default: *630 + default: *640 '404': *6 '304': *35 '403': *27 @@ -100849,7 +101999,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: - - *631 + - *641 responses: '204': description: Response @@ -100878,7 +102028,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &652 + - &662 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 @@ -100903,11 +102053,11 @@ paths: type: array items: *59 examples: - default-response: *632 + default-response: *642 application/vnd.github.v3.star+json: schema: type: array - items: &653 + items: &663 title: Starred Repository description: Starred Repository type: object @@ -101063,8 +102213,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: - - *289 - - *290 + - *294 + - *295 responses: '204': description: Response if this repository is starred by you @@ -101092,8 +102242,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *289 - - *290 + - *294 + - *295 responses: '204': description: Response @@ -101117,8 +102267,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *289 - - *290 + - *294 + - *295 responses: '204': description: Response @@ -101151,9 +102301,9 @@ paths: application/json: schema: type: array - items: *116 + items: *119 examples: - default: *211 + default: *214 headers: Link: *57 '304': *35 @@ -101190,7 +102340,7 @@ paths: application/json: schema: type: array - items: *274 + items: *279 examples: default: value: @@ -101276,10 +102426,10 @@ paths: application/json: schema: oneOf: - - *605 - - *604 + - *616 + - *615 examples: - default-response: &634 + default-response: &644 summary: Default response value: login: octocat @@ -101314,7 +102464,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &635 + response-with-git-hub-plan-information: &645 summary: Response with GitHub plan information value: login: octocat @@ -101374,7 +102524,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *633 + - *643 - *17 responses: '200': @@ -101385,7 +102535,7 @@ paths: type: array items: *4 examples: - default: *191 + default: *194 headers: Link: example: ; rel="next" @@ -101415,7 +102565,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-a-user parameters: - - *129 + - *132 responses: '200': description: Response @@ -101423,11 +102573,11 @@ paths: application/json: schema: oneOf: - - *605 - - *604 + - *616 + - *615 examples: - default-response: *634 - response-with-git-hub-plan-information: *635 + default-response: *644 + response-with-git-hub-plan-information: *645 '404': *6 x-github: githubCloudOnly: false @@ -101453,7 +102603,7 @@ paths: - *17 - *38 - *39 - - *129 + - *132 requestBody: required: true content: @@ -101476,8 +102626,8 @@ paths: required: - subject_digests examples: - default: *636 - withPredicateType: *637 + default: *646 + withPredicateType: *647 responses: '200': description: Response @@ -101531,7 +102681,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *638 + default: *648 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101549,7 +102699,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/attestations#delete-attestations-in-bulk parameters: - - *129 + - *132 requestBody: required: true content: @@ -101614,7 +102764,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/attestations#delete-attestations-by-subject-digest parameters: - - *129 + - *132 - name: subject_digest description: Subject Digest in: path @@ -101645,7 +102795,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/attestations#delete-attestations-by-id parameters: - - *129 + - *132 - name: attestation_id description: Attestation ID in: path @@ -101683,7 +102833,7 @@ paths: - *17 - *38 - *39 - - *129 + - *132 - name: subject_digest description: Subject Digest in: path @@ -101733,12 +102883,12 @@ paths: bundle_url: type: string examples: - default: *351 + default: *361 '201': description: Response content: application/json: - schema: *125 + schema: *128 examples: default: value: @@ -101764,7 +102914,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: - - *129 + - *132 responses: '200': description: Response @@ -101772,9 +102922,9 @@ paths: application/json: schema: type: array - items: *205 + items: *208 examples: - default: *623 + default: *633 '403': *27 '401': *23 x-github: @@ -101797,7 +102947,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-for-the-authenticated-user parameters: - - *129 + - *132 - *17 - *19 responses: @@ -101878,7 +103028,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-organization-events-for-the-authenticated-user parameters: - - *129 + - *132 - *90 - *17 - *19 @@ -101968,7 +103118,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-user parameters: - - *129 + - *132 - *17 - *19 responses: @@ -102045,7 +103195,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-followers-of-a-user parameters: - - *129 + - *132 - *17 - *19 responses: @@ -102057,7 +103207,7 @@ paths: type: array items: *4 examples: - default: *191 + default: *194 headers: Link: *57 x-github: @@ -102076,7 +103226,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-the-people-a-user-follows parameters: - - *129 + - *132 - *17 - *19 responses: @@ -102088,7 +103238,7 @@ paths: type: array items: *4 examples: - default: *191 + default: *194 headers: Link: *57 x-github: @@ -102107,7 +103257,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#check-if-a-user-follows-another-user parameters: - - *129 + - *132 - name: target_user in: path required: true @@ -102134,7 +103284,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gists-for-a-user parameters: - - *129 + - *132 - *64 - *17 - *19 @@ -102168,7 +103318,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-a-user parameters: - - *129 + - *132 - *17 - *19 responses: @@ -102178,9 +103328,9 @@ paths: application/json: schema: type: array - items: *612 + items: *623 examples: - default: *639 + default: *649 headers: Link: *57 x-github: @@ -102204,7 +103354,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-contextual-information-for-a-user parameters: - - *129 + - *132 - name: subject_type description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, @@ -102276,7 +103426,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-user-installation-for-the-authenticated-app parameters: - - *129 + - *132 responses: '200': description: Response @@ -102284,7 +103434,7 @@ paths: application/json: schema: *20 examples: - default: *476 + default: *486 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -102302,7 +103452,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#list-public-keys-for-a-user parameters: - - *129 + - *132 - *17 - *19 responses: @@ -102358,7 +103508,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-organizations-for-a-user parameters: - - *129 + - *132 - *17 - *19 responses: @@ -102368,9 +103518,9 @@ paths: application/json: schema: type: array - items: *146 + items: *149 examples: - default: *621 + default: *631 headers: Link: *57 x-github: @@ -102409,8 +103559,8 @@ paths: - docker - nuget - container - - *622 - - *129 + - *632 + - *132 - *19 - *17 responses: @@ -102420,12 +103570,12 @@ paths: application/json: schema: type: array - items: *205 + items: *208 examples: - default: *623 + default: *633 '403': *27 '401': *23 - '400': *624 + '400': *634 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -102445,17 +103595,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-a-user parameters: - - *207 - - *208 - - *129 + - *210 + - *211 + - *132 responses: '200': description: Response content: application/json: - schema: *205 + schema: *208 examples: - default: *640 + default: *650 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -102476,9 +103626,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user parameters: - - *207 - - *208 - - *129 + - *210 + - *211 + - *132 responses: '204': description: Response @@ -102510,9 +103660,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user parameters: - - *207 - - *208 - - *129 + - *210 + - *211 + - *132 - name: token description: package token schema: @@ -102544,9 +103694,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: - - *207 - - *208 - - *129 + - *210 + - *211 + - *132 responses: '200': description: Response @@ -102554,7 +103704,7 @@ paths: application/json: schema: type: array - items: *209 + items: *212 examples: default: value: @@ -102612,16 +103762,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user parameters: - - *207 - - *208 - *210 - - *129 + - *211 + - *213 + - *132 responses: '200': description: Response content: application/json: - schema: *209 + schema: *212 examples: default: value: @@ -102656,10 +103806,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user parameters: - - *207 - - *208 - - *129 - *210 + - *211 + - *132 + - *213 responses: '204': description: Response @@ -102691,10 +103841,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user parameters: - - *207 - - *208 - - *129 - *210 + - *211 + - *132 + - *213 responses: '204': description: Response @@ -102720,7 +103870,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#list-user-projects parameters: - - *129 + - *132 - name: state description: Indicates the state of the projects to return. in: query @@ -102741,7 +103891,7 @@ paths: application/json: schema: type: array - items: *221 + items: *224 examples: default: value: @@ -102803,7 +103953,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-received-by-the-authenticated-user parameters: - - *129 + - *132 - *17 - *19 responses: @@ -102892,7 +104042,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-received-by-a-user parameters: - - *129 + - *132 - *17 - *19 responses: @@ -102979,7 +104129,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repositories-for-a-user parameters: - - *129 + - *132 - name: type description: Limit results to repositories of the specified type. in: query @@ -103022,9 +104172,9 @@ paths: application/json: schema: type: array - items: *116 + items: *119 examples: - default: *211 + default: *214 headers: Link: *57 x-github: @@ -103048,15 +104198,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-actions-billing-for-a-user parameters: - - *129 + - *132 responses: '200': description: Response content: application/json: - schema: *641 + schema: *651 examples: - default: *642 + default: *652 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -103078,15 +104228,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-packages-billing-for-a-user parameters: - - *129 + - *132 responses: '200': description: Response content: application/json: - schema: *643 + schema: *653 examples: - default: *644 + default: *654 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -103108,15 +104258,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-a-user parameters: - - *129 + - *132 responses: '200': description: Response content: application/json: - schema: *645 + schema: *655 examples: - default: *646 + default: *656 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -103136,11 +104286,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-a-user parameters: - - *129 - - *647 - - *648 - - *649 - - *650 + - *132 + - *657 + - *658 + - *659 + - *660 responses: '200': description: Response when getting a billing usage report @@ -103210,7 +104360,7 @@ paths: repositoryName: user/example '400': *14 '403': *27 - '500': *91 + '500': *94 '503': *62 x-github: githubCloudOnly: false @@ -103229,7 +104379,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-a-user parameters: - - *129 + - *132 - *17 - *19 responses: @@ -103239,9 +104389,9 @@ paths: application/json: schema: type: array - items: *627 + items: *637 examples: - default: *628 + default: *638 headers: Link: *57 x-github: @@ -103261,7 +104411,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user parameters: - - *129 + - *132 - *17 - *19 responses: @@ -103271,9 +104421,9 @@ paths: application/json: schema: type: array - items: *629 + items: *639 examples: - default: *651 + default: *661 headers: Link: *57 x-github: @@ -103297,8 +104447,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - - *129 - - *652 + - *132 + - *662 - *46 - *17 - *19 @@ -103310,11 +104460,11 @@ paths: schema: anyOf: - type: array - items: *653 + items: *663 - type: array items: *59 examples: - default-response: *632 + default-response: *642 headers: Link: *57 x-github: @@ -103333,7 +104483,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-repositories-watched-by-a-user parameters: - - *129 + - *132 - *17 - *19 responses: @@ -103343,9 +104493,9 @@ paths: application/json: schema: type: array - items: *116 + items: *119 examples: - default: *211 + default: *214 headers: Link: *57 x-github: @@ -103474,7 +104624,7 @@ webhooks: type: string enum: - disabled - enterprise: &654 + enterprise: &664 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -103543,7 +104693,7 @@ webhooks: - created_at - updated_at - avatar_url - installation: &655 + installation: &665 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -103564,7 +104714,7 @@ webhooks: required: - id - node_id - organization: &656 + organization: &666 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -103637,7 +104787,7 @@ webhooks: - public_members_url - avatar_url - description - repository: &657 + repository: &667 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property @@ -104550,10 +105700,10 @@ webhooks: type: string enum: - enabled - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -104629,11 +105779,11 @@ webhooks: type: string enum: - created - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 - rule: &658 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 + rule: &668 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) @@ -104856,11 +106006,11 @@ webhooks: type: string enum: - deleted - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 - rule: *658 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 + rule: *668 sender: *4 required: - action @@ -105048,11 +106198,11 @@ webhooks: - everyone required: - from - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 - rule: *658 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 + rule: *668 sender: *4 required: - action @@ -105136,7 +106286,7 @@ webhooks: type: string enum: - completed - check_run: &660 + check_run: &670 title: CheckRun description: A check performed on the code of a given code change type: object @@ -105201,8 +106351,8 @@ webhooks: - MDEwOkNoZWNrU3VpdGU1 pull_requests: type: array - items: *368 - repository: *116 + items: *378 + repository: *119 status: type: string enum: @@ -105246,7 +106396,7 @@ webhooks: - examples: - neutral - deployment: *659 + deployment: *669 details_url: type: string examples: @@ -105306,7 +106456,7 @@ webhooks: - annotations_url pull_requests: type: array - items: *368 + items: *378 started_at: type: string format: date-time @@ -105344,9 +106494,9 @@ webhooks: - output - app - pull_requests - installation: *655 - organization: *656 - repository: *657 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - check_run @@ -105739,10 +106889,10 @@ webhooks: type: string enum: - created - check_run: *660 - installation: *655 - organization: *656 - repository: *657 + check_run: *670 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - check_run @@ -106138,10 +107288,10 @@ webhooks: type: string enum: - requested_action - check_run: *660 - installation: *655 - organization: *656 - repository: *657 + check_run: *670 + installation: *665 + organization: *666 + repository: *667 requested_action: description: The action requested by the user. type: object @@ -106546,10 +107696,10 @@ webhooks: type: string enum: - rerequested - check_run: *660 - installation: *655 - organization: *656 - repository: *657 + check_run: *670 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - check_run @@ -107541,10 +108691,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -108229,10 +109379,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -108911,10 +110061,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -109080,7 +110230,7 @@ webhooks: required: - login - id - dismissed_comment: *383 + dismissed_comment: *393 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -109232,20 +110382,20 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: &661 + commit_oid: &671 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: *654 - installation: *655 - organization: *656 - ref: &662 + enterprise: *664 + installation: *665 + organization: *666 + ref: &672 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: *657 + repository: *667 sender: *4 required: - action @@ -109409,7 +110559,7 @@ webhooks: required: - login - id - dismissed_comment: *383 + dismissed_comment: *393 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -109650,12 +110800,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *661 - enterprise: *654 - installation: *655 - organization: *656 - ref: *662 - repository: *657 + commit_oid: *671 + enterprise: *664 + installation: *665 + organization: *666 + ref: *672 + repository: *667 sender: *4 required: - action @@ -109753,7 +110903,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *383 + dismissed_comment: *393 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -109935,12 +111085,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *661 - enterprise: *654 - installation: *655 - organization: *656 - ref: *662 - repository: *657 + commit_oid: *671 + enterprise: *664 + installation: *665 + organization: *666 + ref: *672 + repository: *667 sender: *4 required: - action @@ -110106,7 +111256,7 @@ webhooks: required: - login - id - dismissed_comment: *383 + dismissed_comment: *393 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -110283,12 +111433,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *661 - enterprise: *654 - installation: *655 - organization: *656 - ref: *662 - repository: *657 + commit_oid: *671 + enterprise: *664 + installation: *665 + organization: *666 + ref: *672 + repository: *667 sender: *4 required: - action @@ -110388,7 +111538,7 @@ webhooks: type: - object - 'null' - dismissed_comment: *383 + dismissed_comment: *393 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -110568,9 +111718,9 @@ webhooks: type: - string - 'null' - enterprise: *654 - installation: *655 - organization: *656 + enterprise: *664 + installation: *665 + organization: *666 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event @@ -110578,7 +111728,7 @@ webhooks: type: - string - 'null' - repository: *657 + repository: *667 sender: *4 required: - action @@ -110674,7 +111824,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *383 + dismissed_comment: *393 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -110821,12 +111971,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *661 - enterprise: *654 - installation: *655 - organization: *656 - ref: *662 - repository: *657 + commit_oid: *671 + enterprise: *664 + installation: *665 + organization: *666 + ref: *672 + repository: *667 sender: *4 required: - action @@ -111088,10 +112238,10 @@ webhooks: - updated_at - author_association - body - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -111172,18 +112322,18 @@ webhooks: type: - string - 'null' - enterprise: *654 - installation: *655 + enterprise: *664 + installation: *665 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *656 - pusher_type: &663 + organization: *666 + pusher_type: &673 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &664 + ref: &674 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -111193,7 +112343,7 @@ webhooks: enum: - tag - branch - repository: *657 + repository: *667 sender: *4 required: - ref @@ -111275,10 +112425,10 @@ webhooks: type: string enum: - created - definition: *222 - enterprise: *654 - installation: *655 - organization: *656 + definition: *225 + enterprise: *664 + installation: *665 + organization: *666 sender: *4 required: - action @@ -111363,9 +112513,9 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *654 - installation: *655 - organization: *656 + enterprise: *664 + installation: *665 + organization: *666 sender: *4 required: - action @@ -111442,10 +112592,10 @@ webhooks: type: string enum: - promote_to_enterprise - definition: *222 - enterprise: *654 - installation: *655 - organization: *656 + definition: *225 + enterprise: *664 + installation: *665 + organization: *666 sender: *4 required: - action @@ -111522,10 +112672,10 @@ webhooks: type: string enum: - updated - definition: *222 - enterprise: *654 - installation: *655 - organization: *656 + definition: *225 + enterprise: *664 + installation: *665 + organization: *666 sender: *4 required: - action @@ -111602,19 +112752,19 @@ webhooks: type: string enum: - updated - enterprise: *654 - installation: *655 - repository: *657 - organization: *656 + enterprise: *664 + installation: *665 + repository: *667 + organization: *666 sender: *4 new_property_values: type: array description: The new custom property values for the repository. - items: *226 + items: *229 old_property_values: type: array description: The old custom property values for the repository. - items: *226 + items: *229 required: - action - repository @@ -111690,18 +112840,18 @@ webhooks: title: delete event type: object properties: - enterprise: *654 - installation: *655 - organization: *656 - pusher_type: *663 - ref: *664 + enterprise: *664 + installation: *665 + organization: *666 + pusher_type: *673 + ref: *674 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *657 + repository: *667 sender: *4 required: - ref @@ -111785,11 +112935,11 @@ webhooks: type: string enum: - auto_dismissed - alert: *435 - installation: *655 - organization: *656 - enterprise: *654 - repository: *657 + alert: *445 + installation: *665 + organization: *666 + enterprise: *664 + repository: *667 sender: *4 required: - action @@ -111873,11 +113023,11 @@ webhooks: type: string enum: - auto_reopened - alert: *435 - installation: *655 - organization: *656 - enterprise: *654 - repository: *657 + alert: *445 + installation: *665 + organization: *666 + enterprise: *664 + repository: *667 sender: *4 required: - action @@ -111961,11 +113111,11 @@ webhooks: type: string enum: - created - alert: *435 - installation: *655 - organization: *656 - enterprise: *654 - repository: *657 + alert: *445 + installation: *665 + organization: *666 + enterprise: *664 + repository: *667 sender: *4 required: - action @@ -112047,11 +113197,11 @@ webhooks: type: string enum: - dismissed - alert: *435 - installation: *655 - organization: *656 - enterprise: *654 - repository: *657 + alert: *445 + installation: *665 + organization: *666 + enterprise: *664 + repository: *667 sender: *4 required: - action @@ -112133,11 +113283,11 @@ webhooks: type: string enum: - fixed - alert: *435 - installation: *655 - organization: *656 - enterprise: *654 - repository: *657 + alert: *445 + installation: *665 + organization: *666 + enterprise: *664 + repository: *667 sender: *4 required: - action @@ -112220,11 +113370,11 @@ webhooks: type: string enum: - reintroduced - alert: *435 - installation: *655 - organization: *656 - enterprise: *654 - repository: *657 + alert: *445 + installation: *665 + organization: *666 + enterprise: *664 + repository: *667 sender: *4 required: - action @@ -112306,11 +113456,11 @@ webhooks: type: string enum: - reopened - alert: *435 - installation: *655 - organization: *656 - enterprise: *654 - repository: *657 + alert: *445 + installation: *665 + organization: *666 + enterprise: *664 + repository: *667 sender: *4 required: - action @@ -112387,9 +113537,9 @@ webhooks: type: string enum: - created - enterprise: *654 - installation: *655 - key: &665 + enterprise: *664 + installation: *665 + key: &675 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -112427,8 +113577,8 @@ webhooks: - verified - created_at - read_only - organization: *656 - repository: *657 + organization: *666 + repository: *667 sender: *4 required: - action @@ -112505,11 +113655,11 @@ webhooks: type: string enum: - deleted - enterprise: *654 - installation: *655 - key: *665 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + key: *675 + organization: *666 + repository: *667 sender: *4 required: - action @@ -113081,12 +114231,12 @@ webhooks: - updated_at - statuses_url - repository_url - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 - workflow: &669 + workflow: &679 title: Workflow type: - object @@ -113824,13 +114974,13 @@ webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *441 + deployment: *451 pull_requests: type: array - items: *523 - repository: *657 - organization: *656 - installation: *655 + items: *533 + repository: *667 + organization: *666 + installation: *665 sender: *4 responses: '200': @@ -113901,7 +115051,7 @@ webhooks: type: string enum: - approved - approver: &666 + approver: &676 type: object properties: avatar_url: @@ -113944,11 +115094,11 @@ webhooks: type: string comment: type: string - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 - reviewers: &667 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 + reviewers: &677 type: array items: type: object @@ -114029,7 +115179,7 @@ webhooks: sender: *4 since: type: string - workflow_job_run: &668 + workflow_job_run: &678 type: object properties: conclusion: @@ -114775,18 +115925,18 @@ webhooks: type: string enum: - rejected - approver: *666 + approver: *676 comment: type: string - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 - reviewers: *667 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 + reviewers: *677 sender: *4 since: type: string - workflow_job_run: *668 + workflow_job_run: *678 workflow_job_runs: type: array items: @@ -115503,13 +116653,13 @@ webhooks: type: string enum: - requested - enterprise: *654 + enterprise: *664 environment: type: string - installation: *655 - organization: *656 - repository: *657 - requestor: &674 + installation: *665 + organization: *666 + repository: *667 + requestor: &684 title: User type: - object @@ -117452,12 +118602,12 @@ webhooks: - updated_at - deployment_url - repository_url - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 - workflow: *669 + workflow: *679 workflow_run: title: Deployment Workflow Run type: @@ -118148,7 +119298,7 @@ webhooks: type: string enum: - answered - answer: &672 + answer: &682 type: object properties: author_association: @@ -118308,7 +119458,7 @@ webhooks: - created_at - updated_at - body - discussion: &670 + discussion: &680 title: Discussion description: A Discussion in a repository. type: object @@ -118604,7 +119754,7 @@ webhooks: - id labels: type: array - items: *486 + items: *497 required: - repository_url - category @@ -118626,10 +119776,10 @@ webhooks: - author_association - active_lock_reason - body - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -118756,11 +119906,11 @@ webhooks: - from required: - category - discussion: *670 - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + discussion: *680 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -118843,11 +119993,11 @@ webhooks: type: string enum: - closed - discussion: *670 - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + discussion: *680 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -118929,7 +120079,7 @@ webhooks: type: string enum: - created - comment: &671 + comment: &681 type: object properties: author_association: @@ -119089,11 +120239,11 @@ webhooks: - updated_at - body - reactions - discussion: *670 - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + discussion: *680 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -119176,12 +120326,12 @@ webhooks: type: string enum: - deleted - comment: *671 - discussion: *670 - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + comment: *681 + discussion: *680 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -119276,12 +120426,12 @@ webhooks: - from required: - body - comment: *671 - discussion: *670 - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + comment: *681 + discussion: *680 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -119365,11 +120515,11 @@ webhooks: type: string enum: - created - discussion: *670 - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + discussion: *680 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -119451,11 +120601,11 @@ webhooks: type: string enum: - deleted - discussion: *670 - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + discussion: *680 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -119555,11 +120705,11 @@ webhooks: type: string required: - from - discussion: *670 - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + discussion: *680 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -119641,10 +120791,10 @@ webhooks: type: string enum: - labeled - discussion: *670 - enterprise: *654 - installation: *655 - label: &673 + discussion: *680 + enterprise: *664 + installation: *665 + label: &683 title: Label type: object properties: @@ -119677,8 +120827,8 @@ webhooks: - color - default - description - organization: *656 - repository: *657 + organization: *666 + repository: *667 sender: *4 required: - action @@ -119761,11 +120911,11 @@ webhooks: type: string enum: - locked - discussion: *670 - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + discussion: *680 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -119847,11 +120997,11 @@ webhooks: type: string enum: - pinned - discussion: *670 - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + discussion: *680 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -119933,11 +121083,11 @@ webhooks: type: string enum: - reopened - discussion: *670 - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + discussion: *680 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -120022,16 +121172,16 @@ webhooks: changes: type: object properties: - new_discussion: *670 - new_repository: *657 + new_discussion: *680 + new_repository: *667 required: - new_discussion - new_repository - discussion: *670 - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + discussion: *680 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -120114,10 +121264,10 @@ webhooks: type: string enum: - unanswered - discussion: *670 - old_answer: *672 - organization: *656 - repository: *657 + discussion: *680 + old_answer: *682 + organization: *666 + repository: *667 sender: *4 required: - action @@ -120199,12 +121349,12 @@ webhooks: type: string enum: - unlabeled - discussion: *670 - enterprise: *654 - installation: *655 - label: *673 - organization: *656 - repository: *657 + discussion: *680 + enterprise: *664 + installation: *665 + label: *683 + organization: *666 + repository: *667 sender: *4 required: - action @@ -120287,11 +121437,11 @@ webhooks: type: string enum: - unlocked - discussion: *670 - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + discussion: *680 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -120373,11 +121523,11 @@ webhooks: type: string enum: - unpinned - discussion: *670 - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + discussion: *680 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -120450,7 +121600,7 @@ webhooks: description: A user forks a repository. type: object properties: - enterprise: *654 + enterprise: *664 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -121128,9 +122278,9 @@ webhooks: type: integer watchers_count: type: integer - installation: *655 - organization: *656 - repository: *657 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - forkee @@ -121276,9 +122426,9 @@ webhooks: title: gollum event type: object properties: - enterprise: *654 - installation: *655 - organization: *656 + enterprise: *664 + installation: *665 + organization: *666 pages: description: The pages that were updated. type: array @@ -121316,7 +122466,7 @@ webhooks: - action - sha - html_url - repository: *657 + repository: *667 sender: *4 required: - pages @@ -121392,10 +122542,10 @@ webhooks: type: string enum: - created - enterprise: *654 + enterprise: *664 installation: *20 - organization: *656 - repositories: &675 + organization: *666 + repositories: &685 description: An array of repository objects that the installation can access. type: array @@ -121421,8 +122571,8 @@ webhooks: - name - full_name - private - repository: *657 - requester: *674 + repository: *667 + requester: *684 sender: *4 required: - action @@ -121497,11 +122647,11 @@ webhooks: type: string enum: - deleted - enterprise: *654 + enterprise: *664 installation: *20 - organization: *656 - repositories: *675 - repository: *657 + organization: *666 + repositories: *685 + repository: *667 requester: type: - 'null' @@ -121578,11 +122728,11 @@ webhooks: type: string enum: - new_permissions_accepted - enterprise: *654 + enterprise: *664 installation: *20 - organization: *656 - repositories: *675 - repository: *657 + organization: *666 + repositories: *685 + repository: *667 requester: type: - 'null' @@ -121659,10 +122809,10 @@ webhooks: type: string enum: - added - enterprise: *654 + enterprise: *664 installation: *20 - organization: *656 - repositories_added: &676 + organization: *666 + repositories_added: &686 description: An array of repository objects, which were added to the installation. type: array @@ -121708,15 +122858,15 @@ webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *657 - repository_selection: &677 + repository: *667 + repository_selection: &687 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *674 + requester: *684 sender: *4 required: - action @@ -121795,10 +122945,10 @@ webhooks: type: string enum: - removed - enterprise: *654 + enterprise: *664 installation: *20 - organization: *656 - repositories_added: *676 + organization: *666 + repositories_added: *686 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -121825,9 +122975,9 @@ webhooks: - name - full_name - private - repository: *657 - repository_selection: *677 - requester: *674 + repository: *667 + repository_selection: *687 + requester: *684 sender: *4 required: - action @@ -121906,11 +123056,11 @@ webhooks: type: string enum: - suspend - enterprise: *654 + enterprise: *664 installation: *20 - organization: *656 - repositories: *675 - repository: *657 + organization: *666 + repositories: *685 + repository: *667 requester: type: - 'null' @@ -122092,10 +123242,10 @@ webhooks: type: string required: - from - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 target_type: type: string @@ -122174,11 +123324,11 @@ webhooks: type: string enum: - unsuspend - enterprise: *654 + enterprise: *664 installation: *20 - organization: *656 - repositories: *675 - repository: *657 + organization: *666 + repositories: *685 + repository: *667 requester: type: - 'null' @@ -122426,8 +123576,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *654 - installation: *655 + enterprise: *664 + installation: *665 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -123244,7 +124394,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *592 + sub_issues_summary: *602 + issue_dependencies_summary: *603 state: description: State of the issue; either 'open' or 'closed' type: string @@ -123261,7 +124412,7 @@ webhooks: title: description: Title of the issue type: string - type: *186 + type: *189 updated_at: type: string format: date-time @@ -123605,8 +124756,8 @@ webhooks: - state - locked - assignee - organization: *656 - repository: *657 + organization: *666 + repository: *667 sender: *4 required: - action @@ -123686,7 +124837,7 @@ webhooks: type: string enum: - deleted - comment: &678 + comment: &688 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -123853,8 +125004,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *654 - installation: *655 + enterprise: *664 + installation: *665 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -124667,7 +125818,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *592 + sub_issues_summary: *602 + issue_dependencies_summary: *603 state: description: State of the issue; either 'open' or 'closed' type: string @@ -124684,7 +125836,7 @@ webhooks: title: description: Title of the issue type: string - type: *186 + type: *189 updated_at: type: string format: date-time @@ -125030,8 +126182,8 @@ webhooks: - state - locked - assignee - organization: *656 - repository: *657 + organization: *666 + repository: *667 sender: *4 required: - action @@ -125111,7 +126263,7 @@ webhooks: type: string enum: - edited - changes: &703 + changes: &713 description: The changes to the comment. type: object properties: @@ -125123,9 +126275,9 @@ webhooks: type: string required: - from - comment: *678 - enterprise: *654 - installation: *655 + comment: *688 + enterprise: *664 + installation: *665 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -125941,7 +127093,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *592 + sub_issues_summary: *602 + issue_dependencies_summary: *603 state: description: State of the issue; either 'open' or 'closed' type: string @@ -125958,7 +127111,7 @@ webhooks: title: description: Title of the issue type: string - type: *186 + type: *189 updated_at: type: string format: date-time @@ -126302,8 +127455,8 @@ webhooks: - state - locked - assignee - organization: *656 - repository: *657 + organization: *666 + repository: *667 sender: *4 required: - action @@ -126393,9 +127546,9 @@ webhooks: type: number blocking_issue: *74 blocking_issue_repo: *59 - installation: *655 - organization: *656 - repository: *657 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -126489,9 +127642,9 @@ webhooks: type: number blocking_issue: *74 blocking_issue_repo: *59 - installation: *655 - organization: *656 - repository: *657 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -126584,9 +127737,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *74 - installation: *655 - organization: *656 - repository: *657 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -126680,9 +127833,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *74 - installation: *655 - organization: *656 - repository: *657 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -126767,10 +127920,10 @@ webhooks: type: string enum: - assigned - assignee: *674 - enterprise: *654 - installation: *655 - issue: &681 + assignee: *684 + enterprise: *664 + installation: *665 + issue: &691 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -127582,7 +128735,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *592 + sub_issues_summary: *602 + issue_dependencies_summary: *603 state: description: State of the issue; either 'open' or 'closed' type: string @@ -127599,7 +128753,7 @@ webhooks: title: description: Title of the issue type: string - type: *186 + type: *189 updated_at: type: string format: date-time @@ -127702,8 +128856,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *656 - repository: *657 + organization: *666 + repository: *667 sender: *4 required: - action @@ -127783,8 +128937,8 @@ webhooks: type: string enum: - closed - enterprise: *654 - installation: *655 + enterprise: *664 + installation: *665 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -128601,7 +129755,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *592 + sub_issues_summary: *602 + issue_dependencies_summary: *603 state: description: State of the issue; either 'open' or 'closed' type: string @@ -128618,7 +129773,7 @@ webhooks: title: description: Title of the issue type: string - type: *186 + type: *189 updated_at: type: string format: date-time @@ -128864,8 +130019,8 @@ webhooks: required: - state - closed_at - organization: *656 - repository: *657 + organization: *666 + repository: *667 sender: *4 required: - action @@ -128944,8 +130099,8 @@ webhooks: type: string enum: - deleted - enterprise: *654 - installation: *655 + enterprise: *664 + installation: *665 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -129753,7 +130908,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *592 + sub_issues_summary: *602 + issue_dependencies_summary: *603 state: description: State of the issue; either 'open' or 'closed' type: string @@ -129770,7 +130926,7 @@ webhooks: title: description: Title of the issue type: string - type: *186 + type: *189 updated_at: type: string format: date-time @@ -129872,8 +131028,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *656 - repository: *657 + organization: *666 + repository: *667 sender: *4 required: - action @@ -129952,8 +131108,8 @@ webhooks: type: string enum: - demilestoned - enterprise: *654 - installation: *655 + enterprise: *664 + installation: *665 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -130784,7 +131940,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *592 + sub_issues_summary: *602 + issue_dependencies_summary: *603 state: description: State of the issue; either 'open' or 'closed' type: string @@ -130801,7 +131958,7 @@ webhooks: title: description: Title of the issue type: string - type: *186 + type: *189 updated_at: type: string format: date-time @@ -130882,7 +132039,7 @@ webhooks: format: uri user_view_type: type: string - milestone: &679 + milestone: &689 title: Milestone description: A collection of related issues and pull requests. type: object @@ -131025,8 +132182,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *656 - repository: *657 + organization: *666 + repository: *667 sender: *4 required: - action @@ -131125,8 +132282,8 @@ webhooks: type: string required: - from - enterprise: *654 - installation: *655 + enterprise: *664 + installation: *665 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -131938,7 +133095,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *592 + sub_issues_summary: *602 + issue_dependencies_summary: *603 state: description: State of the issue; either 'open' or 'closed' type: string @@ -131952,7 +133110,7 @@ webhooks: timeline_url: type: string format: uri - type: *186 + type: *189 title: description: Title of the issue type: string @@ -132058,9 +133216,9 @@ webhooks: - active_lock_reason - body - reactions - label: *673 - organization: *656 - repository: *657 + label: *683 + organization: *666 + repository: *667 sender: *4 required: - action @@ -132140,8 +133298,8 @@ webhooks: type: string enum: - labeled - enterprise: *654 - installation: *655 + enterprise: *664 + installation: *665 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -132952,7 +134110,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *592 + sub_issues_summary: *602 + issue_dependencies_summary: *603 state: description: State of the issue; either 'open' or 'closed' type: string @@ -132966,7 +134125,7 @@ webhooks: timeline_url: type: string format: uri - type: *186 + type: *189 title: description: Title of the issue type: string @@ -133072,9 +134231,9 @@ webhooks: - active_lock_reason - body - reactions - label: *673 - organization: *656 - repository: *657 + label: *683 + organization: *666 + repository: *667 sender: *4 required: - action @@ -133154,8 +134313,8 @@ webhooks: type: string enum: - locked - enterprise: *654 - installation: *655 + enterprise: *664 + installation: *665 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -133991,7 +135150,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *592 + sub_issues_summary: *602 + issue_dependencies_summary: *603 state: description: State of the issue; either 'open' or 'closed' type: string @@ -134005,7 +135165,7 @@ webhooks: timeline_url: type: string format: uri - type: *186 + type: *189 title: description: Title of the issue type: string @@ -134088,8 +135248,8 @@ webhooks: format: uri user_view_type: type: string - organization: *656 - repository: *657 + organization: *666 + repository: *667 sender: *4 required: - action @@ -134168,8 +135328,8 @@ webhooks: type: string enum: - milestoned - enterprise: *654 - installation: *655 + enterprise: *664 + installation: *665 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -134999,7 +136159,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *592 + sub_issues_summary: *602 + issue_dependencies_summary: *603 state: description: State of the issue; either 'open' or 'closed' type: string @@ -135016,7 +136177,7 @@ webhooks: title: description: Title of the issue type: string - type: *186 + type: *189 updated_at: type: string format: date-time @@ -135096,9 +136257,9 @@ webhooks: format: uri user_view_type: type: string - milestone: *679 - organization: *656 - repository: *657 + milestone: *689 + organization: *666 + repository: *667 sender: *4 required: - action @@ -135990,7 +137151,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *592 + sub_issues_summary: *602 + issue_dependencies_summary: *603 state: description: State of the issue; either 'open' or 'closed' type: string @@ -136086,7 +137248,7 @@ webhooks: required: - login - id - type: *186 + type: *189 required: - id - number @@ -136567,8 +137729,8 @@ webhooks: required: - old_issue - old_repository - enterprise: *654 - installation: *655 + enterprise: *664 + installation: *665 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -137380,7 +138542,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *592 + sub_issues_summary: *602 + issue_dependencies_summary: *603 state: description: State of the issue; either 'open' or 'closed' type: string @@ -137397,7 +138560,7 @@ webhooks: title: description: Title of the issue type: string - type: *186 + type: *189 updated_at: type: string format: date-time @@ -137499,8 +138662,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *656 - repository: *657 + organization: *666 + repository: *667 sender: *4 required: - action @@ -137580,9 +138743,9 @@ webhooks: type: string enum: - pinned - enterprise: *654 - installation: *655 - issue: &680 + enterprise: *664 + installation: *665 + issue: &690 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -138388,7 +139551,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *592 + sub_issues_summary: *602 + issue_dependencies_summary: *603 state: description: State of the issue; either 'open' or 'closed' type: string @@ -138405,7 +139569,7 @@ webhooks: title: description: Title of the issue type: string - type: *186 + type: *189 updated_at: type: string format: date-time @@ -138507,8 +139671,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *656 - repository: *657 + organization: *666 + repository: *667 sender: *4 required: - action @@ -138587,8 +139751,8 @@ webhooks: type: string enum: - reopened - enterprise: *654 - installation: *655 + enterprise: *664 + installation: *665 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -139422,7 +140586,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *592 + sub_issues_summary: *602 + issue_dependencies_summary: *603 state: description: State of the issue; either 'open' or 'closed' type: string @@ -139519,9 +140684,9 @@ webhooks: format: uri user_view_type: type: string - type: *186 - organization: *656 - repository: *657 + type: *189 + organization: *666 + repository: *667 sender: *4 required: - action @@ -140410,7 +141575,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *592 + sub_issues_summary: *602 + issue_dependencies_summary: *603 state: description: State of the issue; either 'open' or 'closed' type: string @@ -140427,7 +141593,7 @@ webhooks: title: description: Title of the issue type: string - type: *186 + type: *189 updated_at: type: string format: date-time @@ -141009,11 +142175,11 @@ webhooks: required: - new_issue - new_repository - enterprise: *654 - installation: *655 - issue: *680 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + issue: *690 + organization: *666 + repository: *667 sender: *4 required: - action @@ -141093,12 +142259,12 @@ webhooks: type: string enum: - typed - enterprise: *654 - installation: *655 - issue: *681 - type: *186 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + issue: *691 + type: *189 + organization: *666 + repository: *667 sender: *4 required: - action @@ -141179,7 +142345,7 @@ webhooks: type: string enum: - unassigned - assignee: &706 + assignee: &716 title: User type: - object @@ -141251,11 +142417,11 @@ webhooks: required: - login - id - enterprise: *654 - installation: *655 - issue: *681 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + issue: *691 + organization: *666 + repository: *667 sender: *4 required: - action @@ -141334,12 +142500,12 @@ webhooks: type: string enum: - unlabeled - enterprise: *654 - installation: *655 - issue: *681 - label: *673 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + issue: *691 + label: *683 + organization: *666 + repository: *667 sender: *4 required: - action @@ -141419,8 +142585,8 @@ webhooks: type: string enum: - unlocked - enterprise: *654 - installation: *655 + enterprise: *664 + installation: *665 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -142254,7 +143420,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *592 + sub_issues_summary: *602 + issue_dependencies_summary: *603 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142271,7 +143438,7 @@ webhooks: title: description: Title of the issue type: string - type: *186 + type: *189 updated_at: type: string format: date-time @@ -142351,8 +143518,8 @@ webhooks: format: uri user_view_type: type: string - organization: *656 - repository: *657 + organization: *666 + repository: *667 sender: *4 required: - action @@ -142432,11 +143599,11 @@ webhooks: type: string enum: - unpinned - enterprise: *654 - installation: *655 - issue: *680 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + issue: *690 + organization: *666 + repository: *667 sender: *4 required: - action @@ -142515,12 +143682,12 @@ webhooks: type: string enum: - untyped - enterprise: *654 - installation: *655 - issue: *681 - type: *186 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + issue: *691 + type: *189 + organization: *666 + repository: *667 sender: *4 required: - action @@ -142600,11 +143767,11 @@ webhooks: type: string enum: - created - enterprise: *654 - installation: *655 - label: *673 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + label: *683 + organization: *666 + repository: *667 sender: *4 required: - action @@ -142682,11 +143849,11 @@ webhooks: type: string enum: - deleted - enterprise: *654 - installation: *655 - label: *673 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + label: *683 + organization: *666 + repository: *667 sender: *4 required: - action @@ -142796,11 +143963,11 @@ webhooks: type: string required: - from - enterprise: *654 - installation: *655 - label: *673 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + label: *683 + organization: *666 + repository: *667 sender: *4 required: - action @@ -142882,9 +144049,9 @@ webhooks: - cancelled effective_date: type: string - enterprise: *654 - installation: *655 - marketplace_purchase: &682 + enterprise: *664 + installation: *665 + marketplace_purchase: &692 title: Marketplace Purchase type: object required: @@ -142972,8 +144139,8 @@ webhooks: type: integer unit_count: type: integer - organization: *656 - previous_marketplace_purchase: &683 + organization: *666 + previous_marketplace_purchase: &693 title: Marketplace Purchase type: object properties: @@ -143057,7 +144224,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *657 + repository: *667 sender: *4 required: - action @@ -143137,10 +144304,10 @@ webhooks: - changed effective_date: type: string - enterprise: *654 - installation: *655 - marketplace_purchase: *682 - organization: *656 + enterprise: *664 + installation: *665 + marketplace_purchase: *692 + organization: *666 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -143228,7 +144395,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *657 + repository: *667 sender: *4 required: - action @@ -143310,10 +144477,10 @@ webhooks: - pending_change effective_date: type: string - enterprise: *654 - installation: *655 - marketplace_purchase: *682 - organization: *656 + enterprise: *664 + installation: *665 + marketplace_purchase: *692 + organization: *666 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -143399,7 +144566,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *657 + repository: *667 sender: *4 required: - action @@ -143480,8 +144647,8 @@ webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *654 - installation: *655 + enterprise: *664 + installation: *665 marketplace_purchase: title: Marketplace Purchase type: object @@ -143567,9 +144734,9 @@ webhooks: type: integer unit_count: type: integer - organization: *656 - previous_marketplace_purchase: *683 - repository: *657 + organization: *666 + previous_marketplace_purchase: *693 + repository: *667 sender: *4 required: - action @@ -143649,12 +144816,12 @@ webhooks: - purchased effective_date: type: string - enterprise: *654 - installation: *655 - marketplace_purchase: *682 - organization: *656 - previous_marketplace_purchase: *683 - repository: *657 + enterprise: *664 + installation: *665 + marketplace_purchase: *692 + organization: *666 + previous_marketplace_purchase: *693 + repository: *667 sender: *4 required: - action @@ -143756,11 +144923,11 @@ webhooks: type: string required: - to - enterprise: *654 - installation: *655 - member: *674 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + member: *684 + organization: *666 + repository: *667 sender: *4 required: - action @@ -143862,11 +145029,11 @@ webhooks: type: - string - 'null' - enterprise: *654 - installation: *655 - member: *674 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + member: *684 + organization: *666 + repository: *667 sender: *4 required: - action @@ -143945,11 +145112,11 @@ webhooks: type: string enum: - removed - enterprise: *654 - installation: *655 - member: *674 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + member: *684 + organization: *666 + repository: *667 sender: *4 required: - action @@ -144027,11 +145194,11 @@ webhooks: type: string enum: - added - enterprise: *654 - installation: *655 - member: *674 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + member: *684 + organization: *666 + repository: *667 scope: description: The scope of the membership. Currently, can only be `team`. @@ -144109,7 +145276,7 @@ webhooks: required: - login - id - team: &684 + team: &694 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -144302,11 +145469,11 @@ webhooks: type: string enum: - removed - enterprise: *654 - installation: *655 - member: *674 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + member: *684 + organization: *666 + repository: *667 scope: description: The scope of the membership. Currently, can only be `team`. @@ -144385,7 +145552,7 @@ webhooks: required: - login - id - team: *684 + team: *694 required: - action - scope @@ -144467,8 +145634,8 @@ webhooks: type: string enum: - checks_requested - installation: *655 - merge_group: &685 + installation: *665 + merge_group: &695 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -144487,15 +145654,15 @@ webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *372 + head_commit: *382 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *656 - repository: *657 + organization: *666 + repository: *667 sender: *4 required: - action @@ -144581,10 +145748,10 @@ webhooks: - merged - invalidated - dequeued - installation: *655 - merge_group: *685 - organization: *656 - repository: *657 + installation: *665 + merge_group: *695 + organization: *666 + repository: *667 sender: *4 required: - action @@ -144657,7 +145824,7 @@ webhooks: type: string enum: - deleted - enterprise: *654 + enterprise: *664 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -144766,12 +145933,12 @@ webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *655 - organization: *656 + installation: *665 + organization: *666 repository: anyOf: - type: 'null' - - *657 + - *667 sender: *4 required: - action @@ -144851,11 +146018,11 @@ webhooks: type: string enum: - closed - enterprise: *654 - installation: *655 - milestone: *679 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + milestone: *689 + organization: *666 + repository: *667 sender: *4 required: - action @@ -144934,9 +146101,9 @@ webhooks: type: string enum: - created - enterprise: *654 - installation: *655 - milestone: &686 + enterprise: *664 + installation: *665 + milestone: &696 title: Milestone description: A collection of related issues and pull requests. type: object @@ -145078,8 +146245,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *656 - repository: *657 + organization: *666 + repository: *667 sender: *4 required: - action @@ -145158,11 +146325,11 @@ webhooks: type: string enum: - deleted - enterprise: *654 - installation: *655 - milestone: *679 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + milestone: *689 + organization: *666 + repository: *667 sender: *4 required: - action @@ -145272,11 +146439,11 @@ webhooks: type: string required: - from - enterprise: *654 - installation: *655 - milestone: *679 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + milestone: *689 + organization: *666 + repository: *667 sender: *4 required: - action @@ -145356,11 +146523,11 @@ webhooks: type: string enum: - opened - enterprise: *654 - installation: *655 - milestone: *686 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + milestone: *696 + organization: *666 + repository: *667 sender: *4 required: - action @@ -145439,11 +146606,11 @@ webhooks: type: string enum: - blocked - blocked_user: *674 - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + blocked_user: *684 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -145522,11 +146689,11 @@ webhooks: type: string enum: - unblocked - blocked_user: *674 - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + blocked_user: *684 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -145605,9 +146772,9 @@ webhooks: type: string enum: - deleted - enterprise: *654 - installation: *655 - membership: &687 + enterprise: *664 + installation: *665 + membership: &697 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -145717,8 +146884,8 @@ webhooks: - role - organization_url - user - organization: *656 - repository: *657 + organization: *666 + repository: *667 sender: *4 required: - action @@ -145796,11 +146963,11 @@ webhooks: type: string enum: - member_added - enterprise: *654 - installation: *655 - membership: *687 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + membership: *697 + organization: *666 + repository: *667 sender: *4 required: - action @@ -145879,8 +147046,8 @@ webhooks: type: string enum: - member_invited - enterprise: *654 - installation: *655 + enterprise: *664 + installation: *665 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -146002,10 +147169,10 @@ webhooks: - inviter - team_count - invitation_teams_url - organization: *656 - repository: *657 + organization: *666 + repository: *667 sender: *4 - user: *674 + user: *684 required: - action - invitation @@ -146083,11 +147250,11 @@ webhooks: type: string enum: - member_removed - enterprise: *654 - installation: *655 - membership: *687 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + membership: *697 + organization: *666 + repository: *667 sender: *4 required: - action @@ -146174,11 +147341,11 @@ webhooks: properties: from: type: string - enterprise: *654 - installation: *655 - membership: *687 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + membership: *697 + organization: *666 + repository: *667 sender: *4 required: - action @@ -146254,9 +147421,9 @@ webhooks: type: string enum: - published - enterprise: *654 - installation: *655 - organization: *656 + enterprise: *664 + installation: *665 + organization: *666 package: description: Information about the package. type: object @@ -146779,7 +147946,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: &688 + items: &698 title: Ruby Gems metadata type: object properties: @@ -146876,7 +148043,7 @@ webhooks: - owner - package_version - registry - repository: *657 + repository: *667 sender: *4 required: - action @@ -146952,9 +148119,9 @@ webhooks: type: string enum: - updated - enterprise: *654 - installation: *655 - organization: *656 + enterprise: *664 + installation: *665 + organization: *666 package: description: Information about the package. type: object @@ -147316,7 +148483,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *688 + items: *698 source_url: type: string format: uri @@ -147387,7 +148554,7 @@ webhooks: - owner - package_version - registry - repository: *657 + repository: *667 sender: *4 required: - action @@ -147568,12 +148735,12 @@ webhooks: - duration - created_at - updated_at - enterprise: *654 + enterprise: *664 id: type: integer - installation: *655 - organization: *656 - repository: *657 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - id @@ -147650,7 +148817,7 @@ webhooks: type: string enum: - approved - personal_access_token_request: &689 + personal_access_token_request: &699 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -147800,10 +148967,10 @@ webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *654 - organization: *656 + enterprise: *664 + organization: *666 sender: *4 - installation: *655 + installation: *665 required: - action - personal_access_token_request @@ -147880,11 +149047,11 @@ webhooks: type: string enum: - cancelled - personal_access_token_request: *689 - enterprise: *654 - organization: *656 + personal_access_token_request: *699 + enterprise: *664 + organization: *666 sender: *4 - installation: *655 + installation: *665 required: - action - personal_access_token_request @@ -147960,11 +149127,11 @@ webhooks: type: string enum: - created - personal_access_token_request: *689 - enterprise: *654 - organization: *656 + personal_access_token_request: *699 + enterprise: *664 + organization: *666 sender: *4 - installation: *655 + installation: *665 required: - action - personal_access_token_request @@ -148039,11 +149206,11 @@ webhooks: type: string enum: - denied - personal_access_token_request: *689 - organization: *656 - enterprise: *654 + personal_access_token_request: *699 + organization: *666 + enterprise: *664 sender: *4 - installation: *655 + installation: *665 required: - action - personal_access_token_request @@ -148148,7 +149315,7 @@ webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *690 + last_response: *700 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -148180,8 +149347,8 @@ webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *656 - repository: *657 + organization: *666 + repository: *667 sender: *4 zen: description: Random string of GitHub zen. @@ -148426,10 +149593,10 @@ webhooks: - from required: - note - enterprise: *654 - installation: *655 - organization: *656 - project_card: &691 + enterprise: *664 + installation: *665 + organization: *666 + project_card: &701 title: Project Card type: object properties: @@ -148552,7 +149719,7 @@ webhooks: - creator - created_at - updated_at - repository: *657 + repository: *667 sender: *4 required: - action @@ -148633,11 +149800,11 @@ webhooks: type: string enum: - created - enterprise: *654 - installation: *655 - organization: *656 - project_card: *691 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + project_card: *701 + repository: *667 sender: *4 required: - action @@ -148717,9 +149884,9 @@ webhooks: type: string enum: - deleted - enterprise: *654 - installation: *655 - organization: *656 + enterprise: *664 + installation: *665 + organization: *666 project_card: title: Project Card type: object @@ -148849,7 +150016,7 @@ webhooks: repository: anyOf: - type: 'null' - - *657 + - *667 sender: *4 required: - action @@ -148943,11 +150110,11 @@ webhooks: - from required: - note - enterprise: *654 - installation: *655 - organization: *656 - project_card: *691 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + project_card: *701 + repository: *667 sender: *4 required: - action @@ -149041,9 +150208,9 @@ webhooks: - from required: - column_id - enterprise: *654 - installation: *655 - organization: *656 + enterprise: *664 + installation: *665 + organization: *666 project_card: allOf: - title: Project Card @@ -149240,7 +150407,7 @@ webhooks: type: string required: - after_id - repository: *657 + repository: *667 sender: *4 required: - action @@ -149320,10 +150487,10 @@ webhooks: type: string enum: - closed - enterprise: *654 - installation: *655 - organization: *656 - project: &693 + enterprise: *664 + installation: *665 + organization: *666 + project: &703 title: Project type: object properties: @@ -149450,7 +150617,7 @@ webhooks: - creator - created_at - updated_at - repository: *657 + repository: *667 sender: *4 required: - action @@ -149530,10 +150697,10 @@ webhooks: type: string enum: - created - enterprise: *654 - installation: *655 - organization: *656 - project_column: &692 + enterprise: *664 + installation: *665 + organization: *666 + project_column: &702 title: Project Column type: object properties: @@ -149573,7 +150740,7 @@ webhooks: - name - created_at - updated_at - repository: *657 + repository: *667 sender: *4 required: - action @@ -149652,14 +150819,14 @@ webhooks: type: string enum: - deleted - enterprise: *654 - installation: *655 - organization: *656 - project_column: *692 + enterprise: *664 + installation: *665 + organization: *666 + project_column: *702 repository: anyOf: - type: 'null' - - *657 + - *667 sender: *4 required: - action @@ -149748,11 +150915,11 @@ webhooks: type: string required: - from - enterprise: *654 - installation: *655 - organization: *656 - project_column: *692 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + project_column: *702 + repository: *667 sender: *4 required: - action @@ -149832,11 +150999,11 @@ webhooks: type: string enum: - moved - enterprise: *654 - installation: *655 - organization: *656 - project_column: *692 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + project_column: *702 + repository: *667 sender: *4 required: - action @@ -149916,11 +151083,11 @@ webhooks: type: string enum: - created - enterprise: *654 - installation: *655 - organization: *656 - project: *693 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + project: *703 + repository: *667 sender: *4 required: - action @@ -150000,14 +151167,14 @@ webhooks: type: string enum: - deleted - enterprise: *654 - installation: *655 - organization: *656 - project: *693 + enterprise: *664 + installation: *665 + organization: *666 + project: *703 repository: anyOf: - type: 'null' - - *657 + - *667 sender: *4 required: - action @@ -150108,11 +151275,11 @@ webhooks: type: string required: - from - enterprise: *654 - installation: *655 - organization: *656 - project: *693 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + project: *703 + repository: *667 sender: *4 required: - action @@ -150191,11 +151358,11 @@ webhooks: type: string enum: - reopened - enterprise: *654 - installation: *655 - organization: *656 - project: *693 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + project: *703 + repository: *667 sender: *4 required: - action @@ -150276,9 +151443,9 @@ webhooks: type: string enum: - closed - installation: *655 - organization: *656 - projects_v2: &694 + installation: *665 + organization: *666 + projects_v2: &704 title: Projects v2 Project description: A projects v2 project type: object @@ -150331,6 +151498,72 @@ webhooks: anyOf: - type: 'null' - *4 + state: + type: string + enum: + - open + - closed + latest_status_update: + anyOf: + - type: 'null' + - &709 + 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 + examples: + - '2022-04-28T12:00:00Z' + updated_at: + type: string + format: date-time + examples: + - '2022-04-28T12:00:00Z' + status: + type: + - string + - 'null' + enum: + - INACTIVE + - ON_TRACK + - AT_RISK + - OFF_TRACK + - COMPLETE + - + start_date: + type: string + format: date + examples: + - '2022-04-28' + target_date: + type: string + format: date + examples: + - '2022-04-28' + body: + description: Body of the status update + type: + - string + - 'null' + examples: + - The project is off to a great start! + required: + - id + - node_id + - created_at + - updated_at + is_template: + type: boolean + description: Whether this project is a template required: - id - node_id @@ -150426,9 +151659,9 @@ webhooks: type: string enum: - created - installation: *655 - organization: *656 - projects_v2: *694 + installation: *665 + organization: *666 + projects_v2: *704 sender: *4 required: - action @@ -150509,9 +151742,9 @@ webhooks: type: string enum: - deleted - installation: *655 - organization: *656 - projects_v2: *694 + installation: *665 + organization: *666 + projects_v2: *704 sender: *4 required: - action @@ -150632,9 +151865,9 @@ webhooks: type: string to: type: string - installation: *655 - organization: *656 - projects_v2: *694 + installation: *665 + organization: *666 + projects_v2: *704 sender: *4 required: - action @@ -150717,7 +151950,7 @@ webhooks: type: string enum: - archived - changes: &698 + changes: &708 type: object properties: archived_at: @@ -150733,9 +151966,9 @@ webhooks: - string - 'null' format: date-time - installation: *655 - organization: *656 - projects_v2_item: &695 + installation: *665 + organization: *666 + projects_v2_item: &705 title: Projects v2 Item description: An item belonging to a project type: object @@ -150874,9 +152107,9 @@ webhooks: - 'null' to: type: string - installation: *655 - organization: *656 - projects_v2_item: *695 + installation: *665 + organization: *666 + projects_v2_item: *705 sender: *4 required: - action @@ -150958,9 +152191,9 @@ webhooks: type: string enum: - created - installation: *655 - organization: *656 - projects_v2_item: *695 + installation: *665 + organization: *666 + projects_v2_item: *705 sender: *4 required: - action @@ -151041,9 +152274,9 @@ webhooks: type: string enum: - deleted - installation: *655 - organization: *656 - projects_v2_item: *695 + installation: *665 + organization: *666 + projects_v2_item: *705 sender: *4 required: - action @@ -151148,7 +152381,7 @@ webhooks: oneOf: - type: string - type: integer - - &696 + - &706 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -151168,7 +152401,7 @@ webhooks: required: - id - name - - &697 + - &707 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -151197,8 +152430,8 @@ webhooks: oneOf: - type: string - type: integer - - *696 - - *697 + - *706 + - *707 type: - 'null' - string @@ -151221,9 +152454,9 @@ webhooks: - 'null' required: - body - installation: *655 - organization: *656 - projects_v2_item: *695 + installation: *665 + organization: *666 + projects_v2_item: *705 sender: *4 required: - action @@ -151320,9 +152553,9 @@ webhooks: type: - string - 'null' - installation: *655 - organization: *656 - projects_v2_item: *695 + installation: *665 + organization: *666 + projects_v2_item: *705 sender: *4 required: - action @@ -151405,10 +152638,10 @@ webhooks: type: string enum: - restored - changes: *698 - installation: *655 - organization: *656 - projects_v2_item: *695 + changes: *708 + installation: *665 + organization: *666 + projects_v2_item: *705 sender: *4 required: - action @@ -151490,9 +152723,9 @@ webhooks: type: string enum: - reopened - installation: *655 - organization: *656 - projects_v2: *694 + installation: *665 + organization: *666 + projects_v2: *704 sender: *4 required: - action @@ -151573,63 +152806,9 @@ webhooks: type: string enum: - created - installation: *655 - organization: *656 - projects_v2_status_update: &699 - 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 - examples: - - '2022-04-28T12:00:00Z' - updated_at: - type: string - format: date-time - examples: - - '2022-04-28T12:00:00Z' - status: - type: - - string - - 'null' - enum: - - INACTIVE - - ON_TRACK - - AT_RISK - - OFF_TRACK - - COMPLETE - - - start_date: - type: string - format: date - examples: - - '2022-04-28' - target_date: - type: string - format: date - examples: - - '2022-04-28' - body: - description: Body of the status update - type: - - string - - 'null' - examples: - - The project is off to a great start! - required: - - id - - node_id - - created_at - - updated_at + installation: *665 + organization: *666 + projects_v2_status_update: *709 sender: *4 required: - action @@ -151710,9 +152889,9 @@ webhooks: type: string enum: - deleted - installation: *655 - organization: *656 - projects_v2_status_update: *699 + installation: *665 + organization: *666 + projects_v2_status_update: *709 sender: *4 required: - action @@ -151858,9 +153037,9 @@ webhooks: - string - 'null' format: date - installation: *655 - organization: *656 - projects_v2_status_update: *699 + installation: *665 + organization: *666 + projects_v2_status_update: *709 sender: *4 required: - action @@ -151931,10 +153110,10 @@ webhooks: title: public event type: object properties: - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - repository @@ -152011,13 +153190,13 @@ webhooks: type: string enum: - assigned - assignee: *674 - enterprise: *654 - installation: *655 - number: &700 + assignee: *684 + enterprise: *664 + installation: *665 + number: &710 description: The pull request number. type: integer - organization: *656 + organization: *666 pull_request: title: Pull Request type: object @@ -154366,7 +155545,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *657 + repository: *667 sender: *4 required: - action @@ -154448,11 +155627,11 @@ webhooks: type: string enum: - auto_merge_disabled - enterprise: *654 - installation: *655 + enterprise: *664 + installation: *665 number: type: integer - organization: *656 + organization: *666 pull_request: title: Pull Request type: object @@ -156794,7 +157973,7 @@ webhooks: - draft reason: type: string - repository: *657 + repository: *667 sender: *4 required: - action @@ -156876,11 +158055,11 @@ webhooks: type: string enum: - auto_merge_enabled - enterprise: *654 - installation: *655 + enterprise: *664 + installation: *665 number: type: integer - organization: *656 + organization: *666 pull_request: title: Pull Request type: object @@ -159222,7 +160401,7 @@ webhooks: - draft reason: type: string - repository: *657 + repository: *667 sender: *4 required: - action @@ -159304,13 +160483,13 @@ webhooks: type: string enum: - closed - enterprise: *654 - installation: *655 - number: *700 - organization: *656 - pull_request: &701 + enterprise: *664 + installation: *665 + number: *710 + organization: *666 + pull_request: &711 allOf: - - *523 + - *533 - type: object properties: allow_auto_merge: @@ -159372,7 +160551,7 @@ webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *657 + repository: *667 sender: *4 required: - action @@ -159453,12 +160632,12 @@ webhooks: type: string enum: - converted_to_draft - enterprise: *654 - installation: *655 - number: *700 - organization: *656 - pull_request: *701 - repository: *657 + enterprise: *664 + installation: *665 + number: *710 + organization: *666 + pull_request: *711 + repository: *667 sender: *4 required: - action @@ -159538,11 +160717,11 @@ webhooks: type: string enum: - demilestoned - enterprise: *654 - milestone: *421 - number: *700 - organization: *656 - pull_request: &702 + enterprise: *664 + milestone: *431 + number: *710 + organization: *666 + pull_request: &712 title: Pull Request type: object properties: @@ -161869,7 +163048,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *657 + repository: *667 sender: *4 required: - action @@ -161948,11 +163127,11 @@ webhooks: type: string enum: - dequeued - enterprise: *654 - installation: *655 + enterprise: *664 + installation: *665 number: type: integer - organization: *656 + organization: *666 pull_request: title: Pull Request type: object @@ -164298,7 +165477,7 @@ webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *657 + repository: *667 sender: *4 required: - action @@ -164422,12 +165601,12 @@ webhooks: type: string required: - from - enterprise: *654 - installation: *655 - number: *700 - organization: *656 - pull_request: *701 - repository: *657 + enterprise: *664 + installation: *665 + number: *710 + organization: *666 + pull_request: *711 + repository: *667 sender: *4 required: - action @@ -164507,11 +165686,11 @@ webhooks: type: string enum: - enqueued - enterprise: *654 - installation: *655 + enterprise: *664 + installation: *665 number: type: integer - organization: *656 + organization: *666 pull_request: title: Pull Request type: object @@ -166842,7 +168021,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *657 + repository: *667 sender: *4 required: - action @@ -166922,11 +168101,11 @@ webhooks: type: string enum: - labeled - enterprise: *654 - installation: *655 - label: *673 - number: *700 - organization: *656 + enterprise: *664 + installation: *665 + label: *683 + number: *710 + organization: *666 pull_request: title: Pull Request type: object @@ -169274,7 +170453,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *657 + repository: *667 sender: *4 required: - action @@ -169355,10 +170534,10 @@ webhooks: type: string enum: - locked - enterprise: *654 - installation: *655 - number: *700 - organization: *656 + enterprise: *664 + installation: *665 + number: *710 + organization: *666 pull_request: title: Pull Request type: object @@ -171704,7 +172883,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *657 + repository: *667 sender: *4 required: - action @@ -171784,12 +172963,12 @@ webhooks: type: string enum: - milestoned - enterprise: *654 - milestone: *421 - number: *700 - organization: *656 - pull_request: *702 - repository: *657 + enterprise: *664 + milestone: *431 + number: *710 + organization: *666 + pull_request: *712 + repository: *667 sender: *4 required: - action @@ -171868,12 +173047,12 @@ webhooks: type: string enum: - opened - enterprise: *654 - installation: *655 - number: *700 - organization: *656 - pull_request: *701 - repository: *657 + enterprise: *664 + installation: *665 + number: *710 + organization: *666 + pull_request: *711 + repository: *667 sender: *4 required: - action @@ -171954,12 +173133,12 @@ webhooks: type: string enum: - ready_for_review - enterprise: *654 - installation: *655 - number: *700 - organization: *656 - pull_request: *701 - repository: *657 + enterprise: *664 + installation: *665 + number: *710 + organization: *666 + pull_request: *711 + repository: *667 sender: *4 required: - action @@ -172039,12 +173218,12 @@ webhooks: type: string enum: - reopened - enterprise: *654 - installation: *655 - number: *700 - organization: *656 - pull_request: *701 - repository: *657 + enterprise: *664 + installation: *665 + number: *710 + organization: *666 + pull_request: *711 + repository: *667 sender: *4 required: - action @@ -172419,9 +173598,9 @@ webhooks: - start_side - side - reactions - enterprise: *654 - installation: *655 - organization: *656 + enterprise: *664 + installation: *665 + organization: *666 pull_request: type: object properties: @@ -174651,7 +175830,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *657 + repository: *667 sender: *4 required: - action @@ -174731,7 +175910,7 @@ webhooks: type: string enum: - deleted - comment: &704 + comment: &714 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -175024,9 +176203,9 @@ webhooks: - start_side - side - reactions - enterprise: *654 - installation: *655 - organization: *656 + enterprise: *664 + installation: *665 + organization: *666 pull_request: type: object properties: @@ -177244,7 +178423,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *657 + repository: *667 sender: *4 required: - action @@ -177324,11 +178503,11 @@ webhooks: type: string enum: - edited - changes: *703 - comment: *704 - enterprise: *654 - installation: *655 - organization: *656 + changes: *713 + comment: *714 + enterprise: *664 + installation: *665 + organization: *666 pull_request: type: object properties: @@ -179549,7 +180728,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *657 + repository: *667 sender: *4 required: - action @@ -179630,9 +180809,9 @@ webhooks: type: string enum: - dismissed - enterprise: *654 - installation: *655 - organization: *656 + enterprise: *664 + installation: *665 + organization: *666 pull_request: title: Simple Pull Request type: object @@ -181865,7 +183044,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *657 + repository: *667 review: description: The review that was affected. type: object @@ -182111,9 +183290,9 @@ webhooks: type: string required: - from - enterprise: *654 - installation: *655 - organization: *656 + enterprise: *664 + installation: *665 + organization: *666 pull_request: title: Simple Pull Request type: object @@ -184227,8 +185406,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *657 - review: &705 + repository: *667 + review: &715 description: The review that was affected. type: object properties: @@ -184461,12 +185640,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *654 - installation: *655 + enterprise: *664 + installation: *665 number: description: The pull request number. type: integer - organization: *656 + organization: *666 pull_request: title: Pull Request type: object @@ -186813,7 +187992,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *657 + repository: *667 requested_reviewer: title: User type: @@ -186899,12 +188078,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *654 - installation: *655 + enterprise: *664 + installation: *665 number: description: The pull request number. type: integer - organization: *656 + organization: *666 pull_request: title: Pull Request type: object @@ -189258,7 +190437,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *657 + repository: *667 requested_team: title: Team description: Groups of organization members that gives permissions @@ -189453,12 +190632,12 @@ webhooks: type: string enum: - review_requested - enterprise: *654 - installation: *655 + enterprise: *664 + installation: *665 number: description: The pull request number. type: integer - organization: *656 + organization: *666 pull_request: title: Pull Request type: object @@ -191807,7 +192986,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *657 + repository: *667 requested_reviewer: title: User type: @@ -191894,12 +193073,12 @@ webhooks: type: string enum: - review_requested - enterprise: *654 - installation: *655 + enterprise: *664 + installation: *665 number: description: The pull request number. type: integer - organization: *656 + organization: *666 pull_request: title: Pull Request type: object @@ -194239,7 +195418,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *657 + repository: *667 requested_team: title: Team description: Groups of organization members that gives permissions @@ -194423,9 +195602,9 @@ webhooks: type: string enum: - submitted - enterprise: *654 - installation: *655 - organization: *656 + enterprise: *664 + installation: *665 + organization: *666 pull_request: title: Simple Pull Request type: object @@ -196661,8 +197840,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *657 - review: *705 + repository: *667 + review: *715 sender: *4 required: - action @@ -196742,9 +197921,9 @@ webhooks: type: string enum: - resolved - enterprise: *654 - installation: *655 - organization: *656 + enterprise: *664 + installation: *665 + organization: *666 pull_request: title: Simple Pull Request type: object @@ -198875,7 +200054,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *657 + repository: *667 sender: *4 thread: type: object @@ -199267,9 +200446,9 @@ webhooks: type: string enum: - unresolved - enterprise: *654 - installation: *655 - organization: *656 + enterprise: *664 + installation: *665 + organization: *666 pull_request: title: Simple Pull Request type: object @@ -201383,7 +202562,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *657 + repository: *667 sender: *4 thread: type: object @@ -201777,10 +202956,10 @@ webhooks: type: string before: type: string - enterprise: *654 - installation: *655 - number: *700 - organization: *656 + enterprise: *664 + installation: *665 + number: *710 + organization: *666 pull_request: title: Pull Request type: object @@ -204115,7 +205294,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *657 + repository: *667 sender: *4 required: - action @@ -204197,11 +205376,11 @@ webhooks: type: string enum: - unassigned - assignee: *706 - enterprise: *654 - installation: *655 - number: *700 - organization: *656 + assignee: *716 + enterprise: *664 + installation: *665 + number: *710 + organization: *666 pull_request: title: Pull Request type: object @@ -206551,7 +207730,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *657 + repository: *667 sender: *4 required: - action @@ -206630,11 +207809,11 @@ webhooks: type: string enum: - unlabeled - enterprise: *654 - installation: *655 - label: *673 - number: *700 - organization: *656 + enterprise: *664 + installation: *665 + label: *683 + number: *710 + organization: *666 pull_request: title: Pull Request type: object @@ -208973,7 +210152,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *657 + repository: *667 sender: *4 required: - action @@ -209054,10 +210233,10 @@ webhooks: type: string enum: - unlocked - enterprise: *654 - installation: *655 - number: *700 - organization: *656 + enterprise: *664 + installation: *665 + number: *710 + organization: *666 pull_request: title: Pull Request type: object @@ -211386,7 +212565,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *657 + repository: *667 sender: *4 required: - action @@ -211589,7 +212768,7 @@ webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *654 + enterprise: *664 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -211684,8 +212863,8 @@ webhooks: - url - author - committer - installation: *655 - organization: *656 + installation: *665 + organization: *666 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -212273,9 +213452,9 @@ webhooks: type: string enum: - published - enterprise: *654 - installation: *655 - organization: *656 + enterprise: *664 + installation: *665 + organization: *666 registry_package: type: object properties: @@ -212752,7 +213931,7 @@ webhooks: type: string rubygems_metadata: type: array - items: *688 + items: *698 summary: type: string tag_name: @@ -212808,7 +213987,7 @@ webhooks: - owner - package_version - registry - repository: *657 + repository: *667 sender: *4 required: - action @@ -212886,9 +214065,9 @@ webhooks: type: string enum: - updated - enterprise: *654 - installation: *655 - organization: *656 + enterprise: *664 + installation: *665 + organization: *666 registry_package: type: object properties: @@ -213200,7 +214379,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *688 + items: *698 summary: type: string tag_name: @@ -213250,7 +214429,7 @@ webhooks: - owner - package_version - registry - repository: *657 + repository: *667 sender: *4 required: - action @@ -213327,10 +214506,10 @@ webhooks: type: string enum: - created - enterprise: *654 - installation: *655 - organization: *656 - release: &707 + enterprise: *664 + installation: *665 + organization: *666 + release: &717 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -213655,7 +214834,7 @@ webhooks: - tarball_url - zipball_url - body - repository: *657 + repository: *667 sender: *4 required: - action @@ -213732,11 +214911,11 @@ webhooks: type: string enum: - deleted - enterprise: *654 - installation: *655 - organization: *656 - release: *707 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + release: *717 + repository: *667 sender: *4 required: - action @@ -213853,11 +215032,11 @@ webhooks: type: boolean required: - to - enterprise: *654 - installation: *655 - organization: *656 - release: *707 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + release: *717 + repository: *667 sender: *4 required: - action @@ -213935,9 +215114,9 @@ webhooks: type: string enum: - prereleased - enterprise: *654 - installation: *655 - organization: *656 + enterprise: *664 + installation: *665 + organization: *666 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -214267,7 +215446,7 @@ webhooks: - string - 'null' format: uri - repository: *657 + repository: *667 sender: *4 required: - action @@ -214343,10 +215522,10 @@ webhooks: type: string enum: - published - enterprise: *654 - installation: *655 - organization: *656 - release: &708 + enterprise: *664 + installation: *665 + organization: *666 + release: &718 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -214673,7 +215852,7 @@ webhooks: - string - 'null' format: uri - repository: *657 + repository: *667 sender: *4 required: - action @@ -214749,11 +215928,11 @@ webhooks: type: string enum: - released - enterprise: *654 - installation: *655 - organization: *656 - release: *707 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + release: *717 + repository: *667 sender: *4 required: - action @@ -214829,11 +216008,11 @@ webhooks: type: string enum: - unpublished - enterprise: *654 - installation: *655 - organization: *656 - release: *708 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + release: *718 + repository: *667 sender: *4 required: - action @@ -214909,11 +216088,11 @@ webhooks: type: string enum: - published - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 - repository_advisory: *578 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 + repository_advisory: *588 sender: *4 required: - action @@ -214989,11 +216168,11 @@ webhooks: type: string enum: - reported - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 - repository_advisory: *578 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 + repository_advisory: *588 sender: *4 required: - action @@ -215069,10 +216248,10 @@ webhooks: type: string enum: - archived - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -215149,10 +216328,10 @@ webhooks: type: string enum: - created - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -215230,10 +216409,10 @@ webhooks: type: string enum: - deleted - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -215318,10 +216497,10 @@ webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -215436,10 +216615,10 @@ webhooks: - 'null' items: type: string - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -215511,10 +216690,10 @@ webhooks: title: repository_import event type: object properties: - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 status: type: string @@ -215595,10 +216774,10 @@ webhooks: type: string enum: - privatized - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -215675,10 +216854,10 @@ webhooks: type: string enum: - publicized - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -215772,10 +216951,10 @@ webhooks: - name required: - repository - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -215855,11 +217034,11 @@ webhooks: type: string enum: - created - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 - repository_ruleset: *253 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 + repository_ruleset: *256 sender: *4 required: - action @@ -215937,11 +217116,11 @@ webhooks: type: string enum: - deleted - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 - repository_ruleset: *253 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 + repository_ruleset: *256 sender: *4 required: - action @@ -216019,11 +217198,11 @@ webhooks: type: string enum: - edited - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 - repository_ruleset: *253 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 + repository_ruleset: *256 changes: type: object properties: @@ -216042,16 +217221,16 @@ webhooks: properties: added: type: array - items: *228 + items: *231 deleted: type: array - items: *228 + items: *231 updated: type: array items: type: object properties: - condition: *228 + condition: *231 changes: type: object properties: @@ -216084,16 +217263,16 @@ webhooks: properties: added: type: array - items: *543 + items: *553 deleted: type: array - items: *543 + items: *553 updated: type: array items: type: object properties: - rule: *543 + rule: *553 changes: type: object properties: @@ -216330,10 +217509,10 @@ webhooks: - from required: - owner - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -216411,10 +217590,10 @@ webhooks: type: string enum: - unarchived - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -216492,7 +217671,7 @@ webhooks: type: string enum: - create - alert: &709 + alert: &719 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -216616,10 +217795,10 @@ webhooks: type: string enum: - open - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -216829,10 +218008,10 @@ webhooks: type: string enum: - dismissed - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -216910,11 +218089,11 @@ webhooks: type: string enum: - reopen - alert: *709 - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + alert: *719 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -217116,10 +218295,10 @@ webhooks: enum: - fixed - open - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -217197,7 +218376,7 @@ webhooks: type: string enum: - created - alert: &710 + alert: &720 type: object properties: number: *52 @@ -217307,10 +218486,10 @@ webhooks: - 'null' description: Whether the detected secret was found in multiple repositories in the same organization or business. - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -217391,11 +218570,11 @@ webhooks: type: string enum: - created - alert: *710 - installation: *655 - location: *711 - organization: *656 - repository: *657 + alert: *720 + installation: *665 + location: *721 + organization: *666 + repository: *667 sender: *4 required: - location @@ -217633,11 +218812,11 @@ webhooks: type: string enum: - publicly_leaked - alert: *710 - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + alert: *720 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -217715,11 +218894,11 @@ webhooks: type: string enum: - reopened - alert: *710 - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + alert: *720 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -217797,11 +218976,11 @@ webhooks: type: string enum: - resolved - alert: *710 - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + alert: *720 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -217879,11 +219058,11 @@ webhooks: type: string enum: - validated - alert: *710 - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + alert: *720 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -218013,10 +219192,10 @@ webhooks: - organization - enterprise - - repository: *657 - enterprise: *654 - installation: *655 - organization: *656 + repository: *667 + enterprise: *664 + installation: *665 + organization: *666 sender: *4 required: - action @@ -218094,11 +219273,11 @@ webhooks: type: string enum: - published - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 - security_advisory: &712 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 + security_advisory: &722 description: The details of the security advisory, including summary, description, and severity. type: object @@ -218284,11 +219463,11 @@ webhooks: type: string enum: - updated - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 - security_advisory: *712 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 + security_advisory: *722 sender: *4 required: - action @@ -218361,10 +219540,10 @@ webhooks: type: string enum: - withdrawn - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -218550,11 +219729,11 @@ webhooks: from: type: object properties: - security_and_analysis: *227 - enterprise: *654 - installation: *655 - organization: *656 - repository: *300 + security_and_analysis: *230 + enterprise: *664 + installation: *665 + organization: *666 + repository: *305 sender: *4 required: - changes @@ -218632,12 +219811,12 @@ webhooks: type: string enum: - cancelled - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 - sponsorship: &713 + sponsorship: &723 type: object properties: created_at: @@ -218942,12 +220121,12 @@ webhooks: type: string enum: - created - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 - sponsorship: *713 + sponsorship: *723 required: - action - sponsorship @@ -219035,12 +220214,12 @@ webhooks: type: string required: - from - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 - sponsorship: *713 + sponsorship: *723 required: - action - changes @@ -219117,17 +220296,17 @@ webhooks: type: string enum: - pending_cancellation - effective_date: &714 + effective_date: &724 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: *654 - installation: *655 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 - sponsorship: *713 + sponsorship: *723 required: - action - sponsorship @@ -219201,7 +220380,7 @@ webhooks: type: string enum: - pending_tier_change - changes: &715 + changes: &725 type: object properties: tier: @@ -219245,13 +220424,13 @@ webhooks: - from required: - tier - effective_date: *714 - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + effective_date: *724 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 - sponsorship: *713 + sponsorship: *723 required: - action - changes @@ -219328,13 +220507,13 @@ webhooks: type: string enum: - tier_changed - changes: *715 - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + changes: *725 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 - sponsorship: *713 + sponsorship: *723 required: - action - changes @@ -219408,10 +220587,10 @@ webhooks: type: string enum: - created - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -219495,10 +220674,10 @@ webhooks: type: string enum: - deleted - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -219932,15 +221111,15 @@ webhooks: type: - string - 'null' - enterprise: *654 + enterprise: *664 id: description: The unique identifier of the status. type: integer - installation: *655 + installation: *665 name: type: string - organization: *656 - repository: *657 + organization: *666 + repository: *667 sender: *4 sha: description: The Commit SHA. @@ -220056,9 +221235,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *74 - installation: *655 - organization: *656 - repository: *657 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -220148,9 +221327,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *74 - installation: *655 - organization: *656 - repository: *657 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -220240,9 +221419,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *74 - installation: *655 - organization: *656 - repository: *657 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -220332,9 +221511,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *74 - installation: *655 - organization: *656 - repository: *657 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -220411,12 +221590,12 @@ webhooks: title: team_add event type: object properties: - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 - team: &716 + team: &726 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -220609,9 +221788,9 @@ webhooks: type: string enum: - added_to_repository - enterprise: *654 - installation: *655 - organization: *656 + enterprise: *664 + installation: *665 + organization: *666 repository: title: Repository description: A git repository @@ -221081,7 +222260,7 @@ webhooks: - topics - visibility sender: *4 - team: *716 + team: *726 required: - action - team @@ -221157,9 +222336,9 @@ webhooks: type: string enum: - created - enterprise: *654 - installation: *655 - organization: *656 + enterprise: *664 + installation: *665 + organization: *666 repository: title: Repository description: A git repository @@ -221629,7 +222808,7 @@ webhooks: - topics - visibility sender: *4 - team: *716 + team: *726 required: - action - team @@ -221706,9 +222885,9 @@ webhooks: type: string enum: - deleted - enterprise: *654 - installation: *655 - organization: *656 + enterprise: *664 + installation: *665 + organization: *666 repository: title: Repository description: A git repository @@ -222178,7 +223357,7 @@ webhooks: - topics - visibility sender: *4 - team: *716 + team: *726 required: - action - team @@ -222322,9 +223501,9 @@ webhooks: - from required: - permissions - enterprise: *654 - installation: *655 - organization: *656 + enterprise: *664 + installation: *665 + organization: *666 repository: title: Repository description: A git repository @@ -222794,7 +223973,7 @@ webhooks: - topics - visibility sender: *4 - team: *716 + team: *726 required: - action - changes @@ -222872,9 +224051,9 @@ webhooks: type: string enum: - removed_from_repository - enterprise: *654 - installation: *655 - organization: *656 + enterprise: *664 + installation: *665 + organization: *666 repository: title: Repository description: A git repository @@ -223344,7 +224523,7 @@ webhooks: - topics - visibility sender: *4 - team: *716 + team: *726 required: - action - team @@ -223420,10 +224599,10 @@ webhooks: type: string enum: - started - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 required: - action @@ -223496,17 +224675,17 @@ webhooks: title: workflow_dispatch event type: object properties: - enterprise: *654 + enterprise: *664 inputs: type: - object - 'null' additionalProperties: true - installation: *655 - organization: *656 + installation: *665 + organization: *666 ref: type: string - repository: *657 + repository: *667 sender: *4 workflow: type: string @@ -223588,10 +224767,10 @@ webhooks: type: string enum: - completed - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 workflow_job: allOf: @@ -223847,7 +225026,7 @@ webhooks: type: string required: - conclusion - deployment: *441 + deployment: *451 required: - action - repository @@ -223926,10 +225105,10 @@ webhooks: type: string enum: - in_progress - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 workflow_job: allOf: @@ -224211,7 +225390,7 @@ webhooks: required: - status - steps - deployment: *441 + deployment: *451 required: - action - repository @@ -224290,10 +225469,10 @@ webhooks: type: string enum: - queued - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 workflow_job: type: object @@ -224439,7 +225618,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *441 + deployment: *451 required: - action - repository @@ -224518,10 +225697,10 @@ webhooks: type: string enum: - waiting - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 workflow_job: type: object @@ -224668,7 +225847,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *441 + deployment: *451 required: - action - repository @@ -224748,12 +225927,12 @@ webhooks: type: string enum: - completed - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 - workflow: *669 + workflow: *679 workflow_run: title: Workflow Run type: object @@ -225772,12 +226951,12 @@ webhooks: type: string enum: - in_progress - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 - workflow: *669 + workflow: *679 workflow_run: title: Workflow Run type: object @@ -226781,12 +227960,12 @@ webhooks: type: string enum: - requested - enterprise: *654 - installation: *655 - organization: *656 - repository: *657 + enterprise: *664 + installation: *665 + organization: *666 + repository: *667 sender: *4 - workflow: *669 + workflow: *679 workflow_run: title: Workflow Run type: object diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json index 4d2868b329..6a2054eea1 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json @@ -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": [ @@ -29427,6 +29431,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": [ @@ -47569,6 +47597,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": [ @@ -54344,6 +54396,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": [ @@ -58554,17 +58630,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": [ { @@ -58575,29 +58651,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": { @@ -58606,666 +58659,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", - "null" - ], - "description": "The default repository access level for Dependabot updates.", - "enum": [ - "public", - "internal", - null - ], - "examples": [ - "internal" - ] + "days": { + "type": "integer", + "description": "The number of days artifacts and logs are retained" }, - "accessible_repositories": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple Repository", - "description": "A GitHub repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "A unique identifier of the repository.", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "description": "The GraphQL identifier of the repository.", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "description": "The name of the repository.", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "description": "The full, globally unique, name of the repository.", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean", - "description": "Whether the repository is private." - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL to view the repository on GitHub.com.", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The repository description.", - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL to get more information about the repository from the GitHub API.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "description": "A template for the API URL to download the repository as an archive.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "description": "A template for the API URL to list the available assignees for issues in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "description": "A template for the API URL to get information about branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "description": "A template for the API URL to get information about collaborators of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "description": "A template for the API URL to get information about comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "description": "A template for the API URL to get information about commits on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "description": "A template for the API URL to compare two commits or refs.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "description": "A template for the API URL to get the contents of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "description": "A template for the API URL to list the contributors to the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the deployments of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the downloads on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the events of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the forks of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "description": "A template for the API URL to get information about Git commits of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "description": "A template for the API URL to get information about Git refs of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "description": "A template for the API URL to get information about Git tags of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "issue_comment_url": { - "type": "string", - "description": "A template for the API URL to get information about issue comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "description": "A template for the API URL to get information about issue events on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "description": "A template for the API URL to get information about issues on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "description": "A template for the API URL to get information about deploy keys on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "description": "A template for the API URL to get information about labels of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about the languages of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "description": "The API URL to merge branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "description": "A template for the API URL to get information about milestones of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "description": "A template for the API URL to get information about notifications on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "description": "A template for the API URL to get information about pull requests on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "description": "A template for the API URL to get information about releases on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the stargazers on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "description": "A template for the API URL to get information about statuses of a commit.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the subscribers on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "description": "The API URL to subscribe to notifications for this repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about tags on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the teams on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the hooks on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks" - ] - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" - ] - } - ] - } + "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 } } } @@ -59326,22 +58741,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": [ { @@ -59361,50 +58775,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 } } } @@ -59413,7 +58796,7 @@ }, "responses": { "204": { - "description": "Response" + "description": "No content" }, "403": { "description": "Forbidden", @@ -59466,27 +58849,127 @@ } } } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "repository-access" + "category": "actions", + "subcategory": "permissions" } } }, - "/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.", + "/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": [ - "dependabot" + "actions" ], - "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" + "url": "https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization" }, "parameters": [ { @@ -59499,46 +58982,40 @@ } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "default_level": { - "type": "string", - "description": "The default repository access level for Dependabot updates.", - "enum": [ - "public", - "internal" - ], - "examples": [ - "internal" - ] - } + "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" + ] }, - "required": [ - "default_level" - ] - }, - "examples": { - "204": { - "summary": "Example with a 'succeeded' status.", - "value": { - "default_level": "public" + "examples": { + "default": { + "value": { + "approval_policy": "first_time_contributors" + } } } } } - } - }, - "responses": { - "204": { - "description": "Response" }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -59562,6 +59039,39 @@ } } } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set fork PR contributor approval permissions for an organization", + "description": "Sets the fork PR contributor approval policy for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/set-fork-pr-contributor-approval-permissions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" }, "404": { "description": "Resource not found", @@ -59588,27 +59098,133 @@ } } } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "approval_policy": { + "type": "string", + "enum": [ + "first_time_contributors_new_to_github", + "first_time_contributors", + "all_external_contributors" + ], + "description": "The policy that controls when fork PR workflows require approval from a maintainer." + } + }, + "required": [ + "approval_policy" + ] + }, + "examples": { + "default": { + "summary": "Set approval policy to first time contributors", + "value": { + "approval_policy": "first_time_contributors" + } + } + } + } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "repository-access" + "category": "actions", + "subcategory": "permissions" } } }, - "/organizations/{org}/settings/billing/usage": { + "/organizations/{org}/actions/permissions/fork-pr-workflows-private-repos": { "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 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": [ - "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-private-repo-fork-pr-workflow-settings-for-an-organization" }, "parameters": [ { @@ -59619,144 +59235,55 @@ "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", + "required": [ + "run_workflows_from_fork_pull_requests", + "send_write_tokens_to_workflows", + "send_secrets_and_variables", + "require_approval_for_fork_pr_workflows" + ], "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" - ] - } + "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": { - "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" - } - ] + "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 } } } } } }, - "400": { - "description": "Bad Request", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -59778,53 +59305,111 @@ } } } - }, - "application/scim+json": { + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { "schema": { - "title": "Scim Error", - "description": "Scim Error", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { "message": { - "type": [ - "string", - "null" - ] + "type": "string" }, "documentation_url": { - "type": [ - "string", - "null" - ] + "type": "string" }, - "detail": { - "type": [ - "string", - "null" - ] + "url": { + "type": "string" }, "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } + "type": "string" } } } } } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set private repo fork PR workflow settings for an organization", + "description": "Sets the settings for whether workflows from fork pull requests can run on private repositories in an organization.", + "operationId": "actions/set-private-repo-fork-pr-workflows-settings-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "run_workflows_from_fork_pull_requests" + ], + "properties": { + "run_workflows_from_fork_pull_requests": { + "type": "boolean", + "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." + }, + "send_write_tokens_to_workflows": { + "type": "boolean", + "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request." + }, + "send_secrets_and_variables": { + "type": "boolean", + "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks." + }, + "require_approval_for_fork_pr_workflows": { + "type": "boolean", + "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run." + } + } + }, + "examples": { + "default": { + "value": { + "run_workflows_from_fork_pull_requests": true, + "send_write_tokens_to_workflows": false, + "send_secrets_and_variables": false, + "require_approval_for_fork_pr_workflows": true + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Empty response for successful settings update" }, "403": { - "description": "Forbidden", + "description": "Forbidden - Fork PR workflow settings for private repositories are managed by the enterprise owner", "content": { "application/json": { "schema": { @@ -59849,8 +59434,8 @@ } } }, - "500": { - "description": "Internal Error", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -59875,21 +59460,75 @@ } } }, - "503": { - "description": "Service unavailable", + "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": { - "code": { - "type": "string" - }, "message": { "type": "string" }, "documentation_url": { "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } } } } @@ -59898,24 +59537,23 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "billing", - "subcategory": "enhanced-billing" + "category": "actions", + "subcategory": "permissions" } } }, - "/orgs/{org}": { + "/organizations/{org}/actions/permissions/self-hosted-runners": { "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 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" ], - "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-self-hosted-runners-settings-for-an-organization" }, "parameters": [ { @@ -59934,590 +59572,58 @@ "content": { "application/json": { "schema": { - "title": "Organization Full", - "description": "Organization Full", "type": "object", + "required": [ + "enabled_repositories" + ], "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - }, - "name": { - "type": "string", - "examples": [ - "github" - ] - }, - "company": { - "type": "string", - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": "string", - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": "string", - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "github" - ] - }, - "is_verified": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_organization_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_repository_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "private_gists": { - "type": [ - "integer", - "null" - ], - "examples": [ - 81 - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ], - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ], - "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000.", - "examples": [ - 8 - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } - }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": [ - "string", - "null" - ] - }, - "default_repository_branch": { - "type": [ - "string", - "null" - ], - "description": "The default branch for repositories created in this organization.", - "examples": [ - "main" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "members_allowed_repository_creation_type": { - "type": "string", - "examples": [ - "all" - ] - }, - "members_can_create_public_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_public_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_delete_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_change_repo_visibility": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_invite_outside_collaborators": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_delete_issues": { - "type": "boolean", - "examples": [ - true - ] - }, - "display_commenter_full_name_setting_enabled": { - "type": "boolean", - "examples": [ - true - ] - }, - "readers_can_create_discussions": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_teams": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_view_dependency_insights": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "advanced_security_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "dependabot_alerts_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "dependabot_security_updates_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "dependency_graph_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "secret_scanning_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "secret_scanning_push_protection_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "secret_scanning_push_protection_custom_link_enabled": { - "type": "boolean", - "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", - "examples": [ - false - ] - }, - "secret_scanning_push_protection_custom_link": { - "type": [ - "string", - "null" - ], - "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", - "examples": [ - "https://github.com/test-org/test-repo/blob/main/README.md" - ] - }, - "created_at": { + "enabled_repositories": { "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" + "description": "The policy that controls whether self-hosted runners can be used by repositories in the organization", + "enum": [ + "all", + "selected", + "none" ] }, - "updated_at": { + "selected_repositories_url": { "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "deploy_keys_enabled_for_repositories": { - "type": "boolean", - "description": "Controls whether or not deploy keys may be added and used for repositories in the organization.", - "examples": [ - false - ] + "description": "The URL to the endpoint for managing selected repositories for self-hosted runners 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-response": { + "response": { + "summary": "Example response", "value": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "twitter_username": "github", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "type": "Organization", - "total_private_repos": 100, - "owned_private_repos": 100, - "private_gists": 81, - "disk_usage": 10000, - "collaborators": 8, - "billing_email": "mona@github.com", - "plan": { - "name": "Medium", - "space": 400, - "private_repos": 20, - "filled_seats": 4, - "seats": 5 - }, - "default_repository_permission": "read", - "default_repository_branch": "main", - "members_can_create_repositories": true, - "two_factor_requirement_enabled": true, - "members_allowed_repository_creation_type": "all", - "members_can_create_public_repositories": false, - "members_can_create_private_repositories": false, - "members_can_create_internal_repositories": false, - "members_can_create_pages": true, - "members_can_create_public_pages": true, - "members_can_create_private_pages": true, - "members_can_delete_repositories": true, - "members_can_change_repo_visibility": true, - "members_can_invite_outside_collaborators": true, - "members_can_delete_issues": false, - "display_commenter_full_name_setting_enabled": false, - "readers_can_create_discussions": true, - "members_can_create_teams": true, - "members_can_view_dependency_insights": true, - "members_can_fork_private_repositories": false, - "web_commit_signoff_required": false, - "updated_at": "2014-03-03T18:58:10Z", - "deploy_keys_enabled_for_repositories": false, - "dependency_graph_enabled_for_new_repositories": false, - "dependabot_alerts_enabled_for_new_repositories": false, - "dependabot_security_updates_enabled_for_new_repositories": false, - "advanced_security_enabled_for_new_repositories": false, - "secret_scanning_enabled_for_new_repositories": false, - "secret_scanning_push_protection_enabled_for_new_repositories": false, - "secret_scanning_push_protection_custom_link": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md", - "secret_scanning_push_protection_custom_link_enabled": false + "enabled_repositories": "selected", + "selected_repositories_url": "http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories" + } + } + } + } + } + }, + "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" } } } @@ -60552,22 +59658,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 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": [ - "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-self-hosted-runners-settings-for-an-organization" }, "parameters": [ { @@ -60581,173 +59686,30 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { "type": "object", + "required": [ + "enabled_repositories" + ], "properties": { - "billing_email": { - "type": "string", - "description": "Billing email address. This address is not publicized." - }, - "company": { - "type": "string", - "description": "The company name." - }, - "email": { - "type": "string", - "description": "The publicly visible email address." - }, - "twitter_username": { - "type": "string", - "description": "The Twitter username of the company." - }, - "location": { - "type": "string", - "description": "The location." - }, - "name": { - "type": "string", - "description": "The shorthand name of the company." - }, - "description": { - "type": "string", - "description": "The description of the company. The maximum size is 160 characters." - }, - "has_organization_projects": { - "type": "boolean", - "description": "Whether an organization can use organization projects." - }, - "has_repository_projects": { - "type": "boolean", - "description": "Whether repositories that belong to the organization can use repository projects." - }, - "default_repository_permission": { - "type": "string", - "description": "Default permission level members have for organization repositories.", - "enum": [ - "read", - "write", - "admin", - "none" - ], - "default": "read" - }, - "members_can_create_repositories": { - "type": "boolean", - "description": "Whether of non-admin organization members can create repositories. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.", - "default": true - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "description": "Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." - }, - "members_can_create_private_repositories": { - "type": "boolean", - "description": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." - }, - "members_can_create_public_repositories": { - "type": "boolean", - "description": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." - }, - "members_allowed_repository_creation_type": { + "enabled_repositories": { "type": "string", - "description": "Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n**Note:** This parameter is closing down and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.", + "description": "The policy that controls whether self-hosted runners can be used in the organization", "enum": [ "all", - "private", + "selected", "none" ] - }, - "members_can_create_pages": { - "type": "boolean", - "description": "Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.", - "default": true - }, - "members_can_create_public_pages": { - "type": "boolean", - "description": "Whether organization members can create public GitHub Pages sites. Existing published sites will not be impacted.", - "default": true - }, - "members_can_create_private_pages": { - "type": "boolean", - "description": "Whether organization members can create private GitHub Pages sites. Existing published sites will not be impacted.", - "default": true - }, - "members_can_fork_private_repositories": { - "type": "boolean", - "description": "Whether organization members can fork private organization repositories.", - "default": false - }, - "web_commit_signoff_required": { - "type": "boolean", - "description": "Whether contributors to organization repositories are required to sign off on commits they make through GitHub's web interface.", - "default": false - }, - "blog": { - "type": "string", - "examples": [ - "\"http://github.blog\"" - ] - }, - "advanced_security_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", - "deprecated": true - }, - "dependabot_alerts_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", - "deprecated": true - }, - "dependabot_security_updates_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", - "deprecated": true - }, - "dependency_graph_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", - "deprecated": true - }, - "secret_scanning_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", - "deprecated": true - }, - "secret_scanning_push_protection_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", - "deprecated": true - }, - "secret_scanning_push_protection_custom_link_enabled": { - "type": "boolean", - "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection." - }, - "secret_scanning_push_protection_custom_link": { - "type": "string", - "description": "If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret." - }, - "deploy_keys_enabled_for_repositories": { - "type": "boolean", - "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } } }, "examples": { - "default": { + "application/json": { "value": { - "billing_email": "mona@github.com", - "company": "GitHub", - "email": "mona@github.com", - "twitter_username": "github", - "location": "San Francisco", - "name": "github", - "description": "GitHub, the company.", - "default_repository_permission": "read", - "members_can_create_repositories": true, - "members_allowed_repository_creation_type": "all" + "enabled_repositories": "all" } } } @@ -60755,705 +59717,1339 @@ } }, "responses": { - "200": { - "description": "Response", + "204": { + "description": "No content" + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] + "message": { + "type": "string" }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] + "documentation_url": { + "type": "string" }, "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - }, - "name": { - "type": "string", - "examples": [ - "github" - ] - }, - "company": { - "type": "string", - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": "string", - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": "string", - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "github" - ] - }, - "is_verified": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_organization_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_repository_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] + "type": "string" }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "type": { - "type": "string", - "examples": [ - "Organization" - ] + "documentation_url": { + "type": "string" }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] + "url": { + "type": "string" }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] + "status": { + "type": "string" + } + } + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "private_gists": { - "type": [ - "integer", - "null" - ], - "examples": [ - 81 - ] + "documentation_url": { + "type": "string" }, - "disk_usage": { - "type": [ - "integer", - "null" - ], - "examples": [ - 10000 - ] + "url": { + "type": "string" }, - "collaborators": { - "type": [ - "integer", - "null" - ], - "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000.", - "examples": [ - 8 - ] + "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" }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "org@example.com" - ] + "documentation_url": { + "type": "string" }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } } - }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": [ - "string", - "null" - ] - }, - "default_repository_branch": { - "type": [ - "string", - "null" - ], - "description": "The default branch for repositories created in this organization.", - "examples": [ - "main" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "members_allowed_repository_creation_type": { - "type": "string", - "examples": [ - "all" - ] - }, - "members_can_create_public_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_public_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_delete_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_change_repo_visibility": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_invite_outside_collaborators": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_delete_issues": { - "type": "boolean", - "examples": [ - true - ] - }, - "display_commenter_full_name_setting_enabled": { - "type": "boolean", - "examples": [ - true - ] - }, - "readers_can_create_discussions": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_teams": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_view_dependency_insights": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "advanced_security_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "dependabot_alerts_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true + } + } + } + } + } + } + } + }, + "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": [ + { + "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", + "properties": { + "total_count": { + "type": "integer" }, - "dependabot_security_updates_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "dependency_graph_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "secret_scanning_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "secret_scanning_push_protection_enabled_for_new_repositories": { - "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", - "examples": [ - false - ], - "deprecated": true - }, - "secret_scanning_push_protection_custom_link_enabled": { - "type": "boolean", - "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", - "examples": [ - false - ] - }, - "secret_scanning_push_protection_custom_link": { - "type": [ - "string", - "null" - ], - "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", - "examples": [ - "https://github.com/test-org/test-repo/blob/main/README.md" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "deploy_keys_enabled_for_repositories": { - "type": "boolean", - "description": "Controls whether or not deploy keys may be added and used for repositories in the organization.", - "examples": [ - false - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at", - "archived_at" - ] - }, - "examples": { - "default": { - "value": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "twitter_username": "github", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "type": "Organization", - "total_private_repos": 100, - "owned_private_repos": 100, - "private_gists": 81, - "disk_usage": 10000, - "collaborators": 8, - "billing_email": "mona@github.com", - "plan": { - "name": "Medium", - "space": 400, - "private_repos": 20, - "filled_seats": 4, - "seats": 5 - }, - "default_repository_permission": "read", - "default_repository_branch": "main", - "members_can_create_repositories": true, - "two_factor_requirement_enabled": true, - "members_allowed_repository_creation_type": "all", - "members_can_create_public_repositories": false, - "members_can_create_private_repositories": false, - "members_can_create_internal_repositories": false, - "members_can_create_pages": true, - "members_can_create_public_pages": true, - "members_can_create_private_pages": true, - "members_can_delete_repositories": true, - "members_can_change_repo_visibility": true, - "members_can_invite_outside_collaborators": true, - "members_can_delete_issues": false, - "display_commenter_full_name_setting_enabled": false, - "readers_can_create_discussions": true, - "members_can_create_teams": true, - "members_can_view_dependency_insights": true, - "members_can_fork_private_repositories": false, - "web_commit_signoff_required": false, - "updated_at": "2014-03-03T18:58:10Z", - "deploy_keys_enabled_for_repositories": false, - "dependency_graph_enabled_for_new_repositories": false, - "dependabot_alerts_enabled_for_new_repositories": false, - "dependabot_security_updates_enabled_for_new_repositories": false, - "advanced_security_enabled_for_new_repositories": false, - "secret_scanning_enabled_for_new_repositories": false, - "secret_scanning_push_protection_enabled_for_new_repositories": false, - "secret_scanning_push_protection_custom_link": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md", - "secret_scanning_push_protection_custom_link_enabled": false - } - } - } - } - } - }, - "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" + "repositories": { + "type": "array", + "items": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" ] }, - { + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { "type": [ - "integer", + "string", "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" ] }, - { + "spdx_id": { "type": [ - "array", + "string", "null" ], - "items": { - "type": "string" - } + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "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": { + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } } - } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] } } - ] + } + }, + "examples": { + "default": { + "value": { + "total_count": 1, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + ] + } + } } } } }, - "409": { - "description": "Conflict", + "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": { @@ -61480,22 +61076,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "orgs" + "category": "actions", + "subcategory": "permissions" } }, - "delete": { - "summary": "Delete an organization", - "description": "Deletes an organization and all its repositories.\n\nThe organization login will be unavailable for 90 days after deletion.\n\nPlease review the Terms of Service regarding account deletion before using this endpoint:\n\nhttps://docs.github.com/site-policy/github-terms/github-terms-of-service", - "operationId": "orgs/delete", + "put": { + "summary": "Set 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": [ - "orgs" + "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/orgs#delete-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization" }, "parameters": [ { @@ -61508,24 +61103,45 @@ } } ], - "responses": { - "202": { - "description": "Accepted", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "default": { - "value": null + "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" }, - "404": { - "description": "Resource not found", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -61550,8 +61166,8 @@ } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -61575,27 +61191,101 @@ } } } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "orgs" + "category": "actions", + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/cache/usage": { - "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.", + "/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" ], - "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#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" }, "parameters": [ { @@ -61606,69 +61296,191 @@ "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": { - "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } } } } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "cache" + "subcategory": "permissions" } - } - }, - "/orgs/{org}/actions/cache/usage-by-repository": { - "get": { - "summary": "List repositories with GitHub Actions cache usage for an organization", - "description": "Lists repositories and their GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\n\nOAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + }, + "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" ], - "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#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" }, "parameters": [ { @@ -61681,127 +61493,191 @@ } }, { - "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": "repository_id", + "description": "The unique identifier of the repository.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "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", - "repository_cache_usages" + "message", + "documentation_url" ], "properties": { - "total_count": { - "type": "integer" + "message": { + "type": "string" }, - "repository_cache_usages": { + "documentation_url": { + "type": "string" + }, + "errors": { "type": "array", "items": { - "title": "Actions Cache Usage by repository", - "description": "GitHub Actions Cache Usage by repository.", "type": "object", + "required": [ + "code" + ], "properties": { - "full_name": { - "description": "The repository owner and name for the cache usage being shown.", - "type": "string", - "examples": [ - "octo-org/Hello-World" - ] + "resource": { + "type": "string" }, - "active_caches_size_in_bytes": { - "description": "The sum of the size in bytes of all the active cache items in the repository.", - "type": "integer", - "examples": [ - 2322142 - ] + "field": { + "type": "string" }, - "active_caches_count": { - "description": "The number of active caches in the repository.", - "type": "integer", - "examples": [ - 3 + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } ] } - }, - "required": [ - "full_name", - "active_caches_size_in_bytes", - "active_caches_count" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 2, - "repository_cache_usages": [ - { - "full_name": "octo-org/Hello-World", - "active_caches_size_in_bytes": 2322142, - "active_caches_count": 3 - }, - { - "full_name": "octo-org/server", - "active_caches_size_in_bytes": 1022142, - "active_caches_count": 2 } - ] + } } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "cache" + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/hosted-runners": { + "/organizations/{org}/dependabot/repository-access": { "get": { - "summary": "List GitHub-hosted runners for an organization", - "description": "Lists all GitHub-hosted runners configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runner:org` scope to use this endpoint.", + "summary": "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/list-hosted-runners-for-org", + "operationId": "dependabot/repository-access-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization" + "url": "https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization" }, "parameters": [ { @@ -61814,21 +61690,26 @@ } }, { - "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": "page", "in": "query", + "description": "The page number of results to fetch.", + "required": false, "schema": { "type": "integer", - "default": 30 + "minimum": 1, + "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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "name": "per_page", "in": "query", + "description": "Number of results per page.", + "required": false, "schema": { "type": "integer", - "default": 1 + "minimum": 1, + "maximum": 100, + "default": 30 } } ], @@ -61838,291 +61719,720 @@ "content": { "application/json": { "schema": { + "title": "Dependabot Repository Access Details", + "description": "Information about repositories that Dependabot is able to access in an organization", "type": "object", - "required": [ - "total_count", - "runners" - ], "properties": { - "total_count": { - "type": "integer" + "default_level": { + "type": [ + "string", + "null" + ], + "description": "The default repository access level for Dependabot updates.", + "enum": [ + "public", + "internal", + null + ], + "examples": [ + "internal" + ] }, - "runners": { + "accessible_repositories": { "type": "array", "items": { - "title": "GitHub-hosted hosted runner", - "description": "A Github-hosted hosted runner.", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the hosted runner.", - "type": "integer", - "examples": [ - 5 - ] - }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "examples": [ - "my-github-hosted-runner" - ] - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "examples": [ - 2 - ] + "anyOf": [ + { + "type": "null" }, - "image_details": { - "anyOf": [ - { - "type": "null" + { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "A unique identifier of the repository.", + "examples": [ + 1296269 + ] }, - { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository.", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "description": "The name of the repository.", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository.", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "examples": [ - "ubuntu-20.04" + "name": { + "type": [ + "string", + "null" ] }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "examples": [ - 86 + "email": { + "type": [ + "string", + "null" ] }, - "display_name": { - "description": "Display name for this image.", + "login": { "type": "string", "examples": [ - 20.04 + "octocat" ] }, - "source": { - "description": "The image provider.", + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { "type": "string", - "enum": [ - "github", - "partner", - "custom" + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", "id", - "size_gb", - "display_name", - "source" + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] - } - ] - }, - "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.", + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com.", "examples": [ - "8-core" + "https://github.com/octocat/Hello-World" ] }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description.", "examples": [ - 8 + "This your first repo!" ] }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API.", "examples": [ - 32 + "https://api.github.com/repos/octocat/Hello-World" ] }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive.", "examples": [ - 300 + "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks" ] } }, "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ], - "examples": [ - "Ready" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "examples": [ - "linux-x64" - ] - }, - "maximum_runners": { - "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", - "type": "integer", - "default": 10, - "examples": [ - 5 - ] - }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", - "type": "boolean", - "examples": [ - true - ] - }, - "public_ips": { - "description": "The public IP ranges when public IP is enabled for the hosted runners.", - "type": "array", - "items": { - "title": "Public IP for a GitHub-hosted larger runners.", - "description": "Provides details of Public IP for a GitHub-hosted larger runners", - "type": "object", - "properties": { - "enabled": { - "description": "Whether public IP is enabled.", - "type": "boolean", - "examples": [ - true - ] - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "examples": [ - "20.80.208.150" - ] - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "examples": [ - 28 - ] - } - } - } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2022-10-09T23:39:01Z" + "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": [ - "id", - "name", - "image_details", - "machine_size_details", - "status", - "public_ip_enabled", - "platform" ] } } - } + }, + "additionalProperties": false }, "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" - }, + "default_level": "public", + "accessible_repositories": [ { - "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 + "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" }, - "status": "Ready", - "maximum_runners": 20, - "public_ip_enabled": false, - "public_ips": [], - "last_active_on": "2023-04-26T15:23:37Z" + "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" } ] } } } } - }, - "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" + } + } } } } @@ -62131,20 +62441,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "hosted-runners" + "category": "dependabot", + "subcategory": "repository-access" } }, - "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", + "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/hosted-runners#create-a-github-hosted-runner-for-an-organization" + "url": "https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization" }, "parameters": [ { @@ -62164,65 +62474,50 @@ "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" + "repository_ids_to_add": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of repository IDs to add." }, - "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" + "repository_ids_to_remove": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of repository IDs to remove." } }, - "required": [ - "name", - "image", - "size", - "runner_group_id" - ] + "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": { - "name": "My Hosted runner", - "image": { - "id": "ubuntu-latest", - "source": "github" - }, - "runner_group_id": 1, - "size": "4-core", - "maximum_runners": 50, - "enable_static_ip": false + "repository_ids_to_add": [ + 123, + 456 + ] + } + }, + "remove-example": { + "summary": "Remove repositories", + "value": { + "repository_ids_to_remove": [ + 789 + ] } } } @@ -62230,245 +62525,55 @@ } }, "responses": { - "201": { - "description": "Response", + "204": { + "description": "Response" + }, + "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", - "examples": [ - 5 - ] - }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "examples": [ - "my-github-hosted-runner" - ] - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "examples": [ - 2 - ] + "message": { + "type": "string" }, - "image_details": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", - "type": "object", - "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "examples": [ - "ubuntu-20.04" - ] - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "examples": [ - 86 - ] - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "examples": [ - 20.04 - ] - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ] - } - ] + "documentation_url": { + "type": "string" }, - "machine_size_details": { - "title": "Github-owned VM details.", - "description": "Provides details of a particular machine spec.", - "type": "object", - "properties": { - "id": { - "description": "The ID used for the `size` parameter when creating a new runner.", - "type": "string", - "examples": [ - "8-core" - ] - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "examples": [ - 8 - ] - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "examples": [ - 32 - ] - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "examples": [ - 300 - ] - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] + "url": { + "type": "string" }, "status": { - "description": "The status of the runner.", - "type": "string", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ], - "examples": [ - "Ready" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "examples": [ - "linux-x64" - ] - }, - "maximum_runners": { - "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", - "type": "integer", - "default": 10, - "examples": [ - 5 - ] + "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", - "examples": [ - 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", - "examples": [ - true - ] - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "examples": [ - "20.80.208.150" - ] - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "examples": [ - 28 - ] - } - } - } + "url": { + "type": "string" }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2022-10-09T23:39:01Z" - ] - } - }, - "required": [ - "id", - "name", - "image_details", - "machine_size_details", - "status", - "public_ip_enabled", - "platform" - ] - }, - "examples": { - "default": { - "value": { - "id": 5, - "name": "My hosted ubuntu runner", - "runner_group_id": 2, - "platform": "linux-x64", - "image": { - "id": "ubuntu-20.04", - "size": 86 - }, - "machine_size_details": { - "id": "4-core", - "cpu_cores": 4, - "memory_gb": 16, - "storage_gb": 150 - }, - "status": "Ready", - "maximum_runners": 10, - "public_ip_enabled": true, - "public_ips": [ - { - "enabled": true, - "prefix": "20.80.208.150", - "length": 31 - } - ], - "last_active_on": "2022-10-09T23:39:01Z" + "status": { + "type": "string" } } } @@ -62477,24 +62582,24 @@ } }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, - "category": "actions", - "subcategory": "hosted-runners" + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "repository-access" } } }, - "/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", + "/organizations/{org}/dependabot/repository-access/default-level": { + "put": { + "summary": "Set the default repository access level for Dependabot", + "description": "Sets the default level of repository access Dependabot will have while performing an update. Available values are:\n- 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories.\n- 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories.\n\nUnauthorized users will not see the existence of this endpoint.\n\nThis operation supports both server-to-server and user-to-server access.", "tags": [ - "actions" + "dependabot" ], + "operationId": "dependabot/set-repository-access-default-level", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization" + "url": "https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot" }, "parameters": [ { @@ -62507,85 +62612,90 @@ } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "default_level": { + "type": "string", + "description": "The default repository access level for Dependabot updates.", + "enum": [ + "public", + "internal" + ], + "examples": [ + "internal" + ] + } + }, + "required": [ + "default_level" + ] + }, + "examples": { + "204": { + "summary": "Example with a 'succeeded' status.", + "value": { + "default_level": "public" + } + } + } + } + } + }, "responses": { - "200": { - "description": "Response", + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "required": [ - "total_count", - "images" - ], "properties": { - "total_count": { - "type": "integer" + "message": { + "type": "string" }, - "images": { - "type": "array", - "items": { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", - "type": "object", - "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "examples": [ - "ubuntu-20.04" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "examples": [ - "linux-x64" - ] - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "examples": [ - 86 - ] - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "examples": [ - 20.04 - ] - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "platform", - "size_gb", - "display_name", - "source" - ] - } + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } - }, - "examples": { - "default": { - "value": { - "id": "ubuntu-20.04", - "platform": "linux-x64", - "size_gb": 86, - "display_name": "20.04", - "source": "github" + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } @@ -62596,22 +62706,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "hosted-runners" + "category": "dependabot", + "subcategory": "repository-access" } } }, - "/orgs/{org}/actions/hosted-runners/images/partner": { + "/organizations/{org}/settings/billing/usage": { "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", + "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/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization" + "url": "https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization" }, "parameters": [ { @@ -62622,74 +62732,113 @@ "schema": { "type": "string" } + }, + { + "name": "year", + "description": "If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "month", + "description": "If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the default `year` is used.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "day", + "description": "If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "hour", + "description": "If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. If no `year`, `month`, or `day` is specified, the default `year`, `month`, and `day` are used.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } } ], "responses": { "200": { - "description": "Response", + "description": "Billing usage report response for an organization", "content": { "application/json": { "schema": { "type": "object", - "required": [ - "total_count", - "images" - ], "properties": { - "total_count": { - "type": "integer" - }, - "images": { + "usageItems": { "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.", + "date": { "type": "string", - "examples": [ - "ubuntu-20.04" - ] + "description": "Date of the usage line item." }, - "platform": { - "description": "The operating system of the image.", + "product": { "type": "string", - "examples": [ - "linux-x64" - ] + "description": "Product name." }, - "size_gb": { - "description": "Image size in GB.", + "sku": { + "type": "string", + "description": "SKU name." + }, + "quantity": { "type": "integer", - "examples": [ - 86 - ] + "description": "Quantity of the usage line item." }, - "display_name": { - "description": "Display name for this image.", + "unitType": { "type": "string", - "examples": [ - 20.04 - ] + "description": "Unit type of the usage line item." }, - "source": { - "description": "The image provider.", + "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", - "enum": [ - "github", - "partner", - "custom" - ] + "description": "Name of the organization." + }, + "repositoryName": { + "type": "string", + "description": "Name of the repository." } }, "required": [ - "id", - "platform", - "size_gb", - "display_name", - "source" + "date", + "product", + "sku", + "quantity", + "unitType", + "pricePerUnit", + "grossAmount", + "discountAmount", + "netAmount", + "organizationName" ] } } @@ -62698,269 +62847,162 @@ "examples": { "default": { "value": { - "id": "ubuntu-20.04", - "platform": "linux-x64", - "size_gb": 86, - "display_name": "20.04", - "source": "github" + "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" + } + ] } } } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "hosted-runners" - } - } - }, - "/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/hosted-runners#get-limits-on-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" - } - } - ], - "responses": { - "200": { - "description": "Response", + }, + "400": { + "description": "Bad Request", "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.", - "examples": [ - 50 - ] - }, - "current_usage": { - "type": "integer", - "description": "The current number of static public IP addresses in use by Hosted Runners.", - "examples": [ - 17 - ] - } - }, - "required": [ - "maximum", - "current_usage" - ] - } - }, - "required": [ - "public_ips" - ] - }, - "examples": { - "default": { - "value": { - "public_ips": { - "current_usage": 17, - "maximum": 50 - } + "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", - "content": { - "application/json": { + }, + "application/scim+json": { "schema": { + "title": "Scim Error", + "description": "Scim Error", "type": "object", - "required": [ - "total_count", - "machine_specs" - ], "properties": { - "total_count": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { "type": "integer" }, - "machine_specs": { + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { "type": "array", "items": { - "title": "Github-owned VM details.", - "description": "Provides details of a particular machine spec.", - "type": "object", - "properties": { - "id": { - "description": "The ID used for the `size` parameter when creating a new runner.", - "type": "string", - "examples": [ - "8-core" - ] - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "examples": [ - 8 - ] - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "examples": [ - 32 - ] - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "examples": [ - 300 - ] - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] + "type": "string" } } } - }, - "examples": { - "default": { - "value": { - "id": "4-core", - "cpu_cores": 4, - "memory_gb": 16, - "storage_gb": 150 + } + } + } + }, + "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": "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", + }, + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "required": [ - "total_count", - "platforms" - ], "properties": { - "total_count": { - "type": "integer" + "message": { + "type": "string" }, - "platforms": { - "type": "array", - "items": { - "type": "string" - } + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } - }, - "examples": { - "default": { - "value": { - "total_count": 1, - "platforms": [ - "linux-x64", - "win-x64" - ] + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" } } } @@ -62971,22 +63013,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "hosted-runners" + "category": "billing", + "subcategory": "enhanced-billing" } } }, - "/orgs/{org}/actions/hosted-runners/{hosted_runner_id}": { + "/orgs/{org}": { "get": { - "summary": "Get a GitHub-hosted runner for an organization", - "description": "Gets a GitHub-hosted runner configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "summary": "Get 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": "actions/get-hosted-runner-for-org", + "operationId": "orgs/get", "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/orgs/orgs#get-an-organization" }, "parameters": [ { @@ -62997,15 +63039,6 @@ "schema": { "type": "string" } - }, - { - "name": "hosted_runner_id", - "description": "Unique identifier of the GitHub-hosted runner.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { @@ -63014,250 +63047,618 @@ "content": { "application/json": { "schema": { - "title": "GitHub-hosted hosted runner", - "description": "A Github-hosted hosted runner.", + "title": "Organization Full", + "description": "Organization Full", "type": "object", "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, "id": { - "description": "The unique identifier of the hosted runner.", "type": "integer", "examples": [ - 5 + 1 ] }, - "name": { - "description": "The name of the hosted runner.", + "node_id": { "type": "string", "examples": [ - "my-github-hosted-runner" + "MDEyOk9yZ2FuaXphdGlvbjE=" ] }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", + "url": { + "type": "string", + "format": "uri", "examples": [ - 2 + "https://api.github.com/orgs/github" ] }, - "image_details": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", - "type": "object", - "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "examples": [ - "ubuntu-20.04" - ] - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "examples": [ - 86 - ] - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "examples": [ - 20.04 - ] - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ] - } + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" ] }, - "machine_size_details": { - "title": "Github-owned VM details.", - "description": "Provides details of a particular machine spec.", - "type": "object", - "properties": { - "id": { - "description": "The ID used for the `size` parameter when creating a new runner.", - "type": "string", - "examples": [ - "8-core" - ] - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "examples": [ - 8 - ] - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "examples": [ - 32 - ] - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "examples": [ - 300 - ] - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" ] }, - "status": { - "description": "The status of the runner.", + "hooks_url": { "type": "string", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ], "examples": [ - "Ready" + "https://api.github.com/orgs/github/hooks" ] }, - "platform": { - "description": "The operating system of the image.", + "issues_url": { "type": "string", "examples": [ - "linux-x64" + "https://api.github.com/orgs/github/issues" ] }, - "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, + "members_url": { + "type": "string", "examples": [ - 5 + "https://api.github.com/orgs/github/members{/member}" ] }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", - "type": "boolean", + "public_members_url": { + "type": "string", "examples": [ - true + "https://api.github.com/orgs/github/public_members{/member}" ] }, - "public_ips": { - "description": "The public IP ranges when public IP is enabled for the hosted runners.", - "type": "array", - "items": { - "title": "Public IP for a GitHub-hosted larger runners.", - "description": "Provides details of Public IP for a GitHub-hosted larger runners", - "type": "object", - "properties": { - "enabled": { - "description": "Whether public IP is enabled.", - "type": "boolean", - "examples": [ - true - ] - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "examples": [ - "20.80.208.150" - ] - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "examples": [ - 28 - ] - } - } - } + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", + "description": { "type": [ "string", "null" ], - "format": "date-time", "examples": [ - "2022-10-09T23:39:01Z" + "A great organization" ] - } - }, - "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 + }, + "name": { + "type": "string", + "examples": [ + "github" + ] + }, + "company": { + "type": "string", + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": "string", + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": "string", + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "github" + ] + }, + "is_verified": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_organization_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_repository_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "private_gists": { + "type": [ + "integer", + "null" + ], + "examples": [ + 81 + ] + }, + "disk_usage": { + "type": [ + "integer", + "null" + ], + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": [ + "integer", + "null" + ], + "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000.", + "examples": [ + 8 + ] + }, + "billing_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "org@example.com" + ] + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": [ + "string", + "null" + ] + }, + "default_repository_branch": { + "type": [ + "string", + "null" ], - "last_active_on": "2022-10-09T23:39:01Z" + "description": "The default branch for repositories created in this organization.", + "examples": [ + "main" + ] + }, + "members_can_create_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "two_factor_requirement_enabled": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "members_allowed_repository_creation_type": { + "type": "string", + "examples": [ + "all" + ] + }, + "members_can_create_public_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_public_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_delete_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_change_repo_visibility": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_invite_outside_collaborators": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_delete_issues": { + "type": "boolean", + "examples": [ + true + ] + }, + "display_commenter_full_name_setting_enabled": { + "type": "boolean", + "examples": [ + true + ] + }, + "readers_can_create_discussions": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_teams": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_view_dependency_insights": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_fork_private_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "advanced_security_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "dependabot_alerts_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "dependabot_security_updates_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "dependency_graph_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "secret_scanning_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "secret_scanning_push_protection_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_custom_link": { + "type": [ + "string", + "null" + ], + "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", + "examples": [ + "https://github.com/test-org/test-repo/blob/main/README.md" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization.", + "examples": [ + false + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description", + "html_url", + "has_organization_projects", + "has_repository_projects", + "public_repos", + "public_gists", + "followers", + "following", + "type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "examples": { + "default-response": { + "value": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "github", + "is_verified": true, + "has_organization_projects": true, + "has_repository_projects": true, + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "html_url": "https://github.com/octocat", + "created_at": "2008-01-14T04:33:35Z", + "type": "Organization", + "total_private_repos": 100, + "owned_private_repos": 100, + "private_gists": 81, + "disk_usage": 10000, + "collaborators": 8, + "billing_email": "mona@github.com", + "plan": { + "name": "Medium", + "space": 400, + "private_repos": 20, + "filled_seats": 4, + "seats": 5 + }, + "default_repository_permission": "read", + "default_repository_branch": "main", + "members_can_create_repositories": true, + "two_factor_requirement_enabled": true, + "members_allowed_repository_creation_type": "all", + "members_can_create_public_repositories": false, + "members_can_create_private_repositories": false, + "members_can_create_internal_repositories": false, + "members_can_create_pages": true, + "members_can_create_public_pages": true, + "members_can_create_private_pages": true, + "members_can_delete_repositories": true, + "members_can_change_repo_visibility": true, + "members_can_invite_outside_collaborators": true, + "members_can_delete_issues": false, + "display_commenter_full_name_setting_enabled": false, + "readers_can_create_discussions": true, + "members_can_create_teams": true, + "members_can_view_dependency_insights": true, + "members_can_fork_private_repositories": false, + "web_commit_signoff_required": false, + "updated_at": "2014-03-03T18:58:10Z", + "deploy_keys_enabled_for_repositories": false, + "dependency_graph_enabled_for_new_repositories": false, + "dependabot_alerts_enabled_for_new_repositories": false, + "dependabot_security_updates_enabled_for_new_repositories": false, + "advanced_security_enabled_for_new_repositories": false, + "secret_scanning_enabled_for_new_repositories": false, + "secret_scanning_push_protection_enabled_for_new_repositories": false, + "secret_scanning_push_protection_custom_link": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md", + "secret_scanning_push_protection_custom_link_enabled": false } } } } - }, - "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" + } + } } } } @@ -63266,20 +63667,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "hosted-runners" + "category": "orgs", + "subcategory": "orgs" } }, "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", + "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/hosted-runners#update-a-github-hosted-runner-for-an-organization" + "url": "https://docs.github.com/rest/orgs/orgs#update-an-organization" }, "parameters": [ { @@ -63290,49 +63691,176 @@ "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, + "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. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.", - "type": "string" + "type": "string", + "description": "The shorthand name of the company." }, - "runner_group_id": { - "description": "The existing runner group to add this runner to.", - "type": "integer" + "description": { + "type": "string", + "description": "The description of the company. The maximum size is 160 characters." }, - "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" + "has_organization_projects": { + "type": "boolean", + "description": "Whether an organization can use organization projects." }, - "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" + "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", + "examples": [ + "\"http://github.blog\"" + ] + }, + "advanced_security_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true + }, + "dependabot_alerts_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true + }, + "dependabot_security_updates_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true + }, + "dependency_graph_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true + }, + "secret_scanning_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true + }, + "secret_scanning_push_protection_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection." + }, + "secret_scanning_push_protection_custom_link": { + "type": "string", + "description": "If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret." + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } } }, "examples": { "default": { "value": { - "name": "My larger runner", - "runner_group_id": 1, - "maximum_runners": 50, - "enable_static_ip": false + "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" } } } @@ -63345,592 +63873,718 @@ "content": { "application/json": { "schema": { - "title": "GitHub-hosted hosted runner", - "description": "A Github-hosted hosted runner.", + "title": "Organization Full", + "description": "Organization Full", "type": "object", "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, "id": { - "description": "The unique identifier of the hosted runner.", "type": "integer", "examples": [ - 5 + 1 ] }, - "name": { - "description": "The name of the hosted runner.", + "node_id": { "type": "string", "examples": [ - "my-github-hosted-runner" + "MDEyOk9yZ2FuaXphdGlvbjE=" ] }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", + "url": { + "type": "string", + "format": "uri", "examples": [ - 2 + "https://api.github.com/orgs/github" ] }, - "image_details": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", - "type": "object", - "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "examples": [ - "ubuntu-20.04" - ] - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "examples": [ - 86 - ] - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "examples": [ - 20.04 - ] - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ] - } + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" ] }, - "machine_size_details": { - "title": "Github-owned VM details.", - "description": "Provides details of a particular machine spec.", - "type": "object", - "properties": { - "id": { - "description": "The ID used for the `size` parameter when creating a new runner.", - "type": "string", - "examples": [ - "8-core" - ] - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "examples": [ - 8 - ] - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "examples": [ - 32 - ] - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "examples": [ - 300 - ] - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" ] }, - "status": { - "description": "The status of the runner.", + "hooks_url": { "type": "string", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ], "examples": [ - "Ready" + "https://api.github.com/orgs/github/hooks" ] }, - "platform": { - "description": "The operating system of the image.", + "issues_url": { "type": "string", "examples": [ - "linux-x64" + "https://api.github.com/orgs/github/issues" ] }, - "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, + "members_url": { + "type": "string", "examples": [ - 5 + "https://api.github.com/orgs/github/members{/member}" ] }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", - "type": "boolean", + "public_members_url": { + "type": "string", "examples": [ - true + "https://api.github.com/orgs/github/public_members{/member}" ] }, - "public_ips": { - "description": "The public IP ranges when public IP is enabled for the hosted runners.", - "type": "array", - "items": { - "title": "Public IP for a GitHub-hosted larger runners.", - "description": "Provides details of Public IP for a GitHub-hosted larger runners", - "type": "object", - "properties": { - "enabled": { - "description": "Whether public IP is enabled.", - "type": "boolean", - "examples": [ - true - ] - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "examples": [ - "20.80.208.150" - ] - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "examples": [ - 28 - ] - } - } - } + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", + "description": { "type": [ "string", "null" ], - "format": "date-time", "examples": [ - "2022-10-09T23:39:01Z" + "A great organization" ] - } - }, - "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 - } + }, + "name": { + "type": "string", + "examples": [ + "github" + ] + }, + "company": { + "type": "string", + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": "string", + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": "string", + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" ], - "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.", + "examples": [ + "github" + ] + }, + "is_verified": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_organization_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_repository_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "public_repos": { "type": "integer", "examples": [ - 5 + 2 ] }, - "name": { - "description": "The name of the hosted runner.", + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "html_url": { "type": "string", + "format": "uri", "examples": [ - "my-github-hosted-runner" + "https://github.com/octocat" ] }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "total_private_repos": { "type": "integer", "examples": [ - 2 + 100 ] }, - "image_details": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", - "type": "object", - "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "examples": [ - "ubuntu-20.04" - ] - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "examples": [ - 86 - ] - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "examples": [ - 20.04 - ] - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ] - } + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 ] }, - "machine_size_details": { - "title": "Github-owned VM details.", - "description": "Provides details of a particular machine spec.", + "private_gists": { + "type": [ + "integer", + "null" + ], + "examples": [ + 81 + ] + }, + "disk_usage": { + "type": [ + "integer", + "null" + ], + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": [ + "integer", + "null" + ], + "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000.", + "examples": [ + 8 + ] + }, + "billing_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "org@example.com" + ] + }, + "plan": { "type": "object", "properties": { - "id": { - "description": "The ID used for the `size` parameter when creating a new runner.", - "type": "string", - "examples": [ - "8-core" - ] + "name": { + "type": "string" }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "examples": [ - 8 - ] + "space": { + "type": "integer" }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "examples": [ - 32 - ] + "private_repos": { + "type": "integer" }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "examples": [ - 300 - ] + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" } }, "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" + "name", + "space", + "private_repos" ] }, - "status": { - "description": "The status of the runner.", - "type": "string", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" + "default_repository_permission": { + "type": [ + "string", + "null" + ] + }, + "default_repository_branch": { + "type": [ + "string", + "null" ], + "description": "The default branch for repositories created in this organization.", "examples": [ - "Ready" + "main" ] }, - "platform": { - "description": "The operating system of the image.", + "members_can_create_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "two_factor_requirement_enabled": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "members_allowed_repository_creation_type": { "type": "string", "examples": [ - "linux-x64" + "all" ] }, - "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, + "members_can_create_public_repositories": { + "type": "boolean", "examples": [ - 5 + true ] }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", + "members_can_create_private_repositories": { "type": "boolean", "examples": [ true ] }, - "public_ips": { - "description": "The public IP ranges when public IP is enabled for the hosted runners.", - "type": "array", - "items": { - "title": "Public IP for a GitHub-hosted larger runners.", - "description": "Provides details of Public IP for a GitHub-hosted larger runners", - "type": "object", - "properties": { - "enabled": { - "description": "Whether public IP is enabled.", - "type": "boolean", - "examples": [ - true - ] - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "examples": [ - "20.80.208.150" - ] - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "examples": [ - 28 - ] - } - } - } + "members_can_create_internal_repositories": { + "type": "boolean", + "examples": [ + true + ] }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", + "members_can_create_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_public_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_delete_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_change_repo_visibility": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_invite_outside_collaborators": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_delete_issues": { + "type": "boolean", + "examples": [ + true + ] + }, + "display_commenter_full_name_setting_enabled": { + "type": "boolean", + "examples": [ + true + ] + }, + "readers_can_create_discussions": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_teams": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_view_dependency_insights": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_fork_private_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "advanced_security_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "dependabot_alerts_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "dependabot_security_updates_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "dependency_graph_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "secret_scanning_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "secret_scanning_push_protection_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ], + "deprecated": true + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_custom_link": { "type": [ "string", "null" ], + "description": "An optional URL string to display to contributors who are blocked from pushing a secret.", + "examples": [ + "https://github.com/test-org/test-repo/blob/main/README.md" + ] + }, + "created_at": { + "type": "string", "format": "date-time", "examples": [ - "2022-10-09T23:39:01Z" + "2008-01-14T04:33:35Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization.", + "examples": [ + false ] } }, "required": [ + "login", + "url", "id", - "name", - "image_details", - "machine_size_details", - "status", - "public_ip_enabled", - "platform" + "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": 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 + "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 }, - "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" + "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": { - "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", + }, + "422": { + "description": "Validation failed", "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" + "oneOf": [ + { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + }, + { + "title": "Validation Error Simple", + "description": "Validation Error Simple", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + } } } - }, - "required": [ - "include_claim_keys" ] - }, - "examples": { - "default": { - "value": { - "include_claim_keys": [ - "repo", - "context" - ] + } + } + } + }, + "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" } } } @@ -63939,21 +64593,22 @@ } }, "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "oidc" + "category": "orgs", + "subcategory": "orgs" } }, - "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.", + "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": [ - "oidc" + "orgs" ], - "operationId": "oidc/update-oidc-custom-sub-template-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization" + "url": "https://docs.github.com/rest/orgs/orgs#delete-an-organization" }, "parameters": [ { @@ -63966,51 +64621,13 @@ } } ], - "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", + "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": { @@ -64074,24 +64691,24 @@ } }, "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [], - "category": "actions", - "subcategory": "oidc" + "category": "orgs", + "subcategory": "orgs" } } }, - "/orgs/{org}/actions/permissions": { + "/orgs/{org}/actions/cache/usage": { "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", + "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/permissions#get-github-actions-permissions-for-an-organization" + "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-an-organization" }, "parameters": [ { @@ -64112,144 +64729,59 @@ "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" - ] + "total_active_caches_count": { + "type": "integer", + "description": "The count of active caches across all repositories of an enterprise or an organization." }, - "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`." + "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": [ - "enabled_repositories" + "total_active_caches_count", + "total_active_caches_size_in_bytes" ] }, "examples": { "default": { "value": { - "enabled_repositories": "all", - "allowed_actions": "selected", - "selected_actions_url": "https://api.github.com/organizations/42/actions/permissions/selected-actions" + "total_active_caches_size_in_bytes": 3344284, + "total_active_caches_count": 5 } } } } - } - } - }, - "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" - } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" } } } } }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "permissions" + "subcategory": "cache" } } }, - "/orgs/{org}/actions/permissions/repositories": { + "/orgs/{org}/actions/cache/usage-by-repository": { "get": { - "summary": "List selected repositories enabled for GitHub Actions in an organization", - "description": "Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/list-selected-repositories-enabled-github-actions-organization", + "summary": "List repositories 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/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization" + "url": "https://docs.github.com/rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization" }, "parameters": [ { @@ -64289,961 +64821,352 @@ "type": "object", "required": [ "total_count", - "repositories" + "repository_cache_usages" ], "properties": { "total_count": { - "type": "number" + "type": "integer" }, - "repositories": { + "repository_cache_usages": { "type": "array", "items": { - "title": "Repository", - "description": "A repository on GitHub.", + "title": "Actions Cache Usage by repository", + "description": "GitHub Actions Cache Usage by repository.", "type": "object", "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { + "full_name": { + "description": "The repository owner and name for the cache usage being shown.", "type": "string", "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "octo-org/Hello-World" ] }, - "name": { - "description": "The name of the repository.", - "type": "string", + "active_caches_size_in_bytes": { + "description": "The sum of the size in bytes of all the active cache items in the repository.", + "type": "integer", "examples": [ - "Team Environment" + 2322142 ] }, - "full_name": { - "type": "string", + "active_caches_count": { + "description": "The number of active caches in the repository.", + "type": "integer", "examples": [ - "octocat/Hello-World" + 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", + "examples": [ + 5 ] }, - "license": { + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "examples": [ + "my-github-hosted-runner" + ] + }, + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "examples": [ + 2 + ] + }, + "image_details": { "anyOf": [ { "type": "null" }, { - "title": "License Simple", - "description": "License Simple", + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", "type": "object", "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", "type": "string", "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" + "ubuntu-20.04" ] }, - "spdx_id": { - "type": [ - "string", - "null" - ], + "size_gb": { + "description": "Image size in GB.", + "type": "integer", "examples": [ - "MIT" + 86 ] }, - "node_id": { + "display_name": { + "description": "Display name for this image.", "type": "string", "examples": [ - "MDc6TGljZW5zZW1pdA==" + 20.04 ] }, - "html_url": { + "source": { + "description": "The image provider.", "type": "string", - "format": "uri" + "enum": [ + "github", + "partner", + "custom" + ] } }, "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" + "id", + "size_gb", + "display_name", + "source" ] } ] }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", + "machine_size_details": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { + "description": "The ID used for the `size` parameter when creating a new runner.", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "8-core" ] }, - "type": { - "type": "string", + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", "examples": [ - "User" + 8 ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", "examples": [ - "\"2020-07-09T00:17:55Z\"" + 32 ] }, - "user_view_type": { - "type": "string", + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", "examples": [ - "public" + 300 ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" + "cpu_cores", + "memory_gb", + "storage_gb" ] }, - "svn_url": { + "status": { + "description": "The status of the runner.", "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", "examples": [ - 108 + "Ready" ] }, - "default_branch": { - "description": "The default branch of the repository.", + "platform": { + "description": "The operating system of the image.", "type": "string", "examples": [ - "master" + "linux-x64" ] }, - "open_issues_count": { + "maximum_runners": { + "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", "type": "integer", + "default": 10, "examples": [ - 0 + 5 ] }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", "type": "boolean", "examples": [ true ] }, - "topics": { + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", "type": "array", "items": { - "type": "string" + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", + "type": "object", + "properties": { + "enabled": { + "description": "Whether public IP is enabled.", + "type": "boolean", + "examples": [ + true + ] + }, + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "examples": [ + "20.80.208.150" + ] + }, + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "examples": [ + 28 + ] + } + } } }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", "type": [ "string", "null" ], "format": "date-time", "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" + "2022-10-09T23:39:01Z" ] - }, - "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" + "image_details", + "machine_size_details", + "status", + "public_ip_enabled", + "platform" ] } } @@ -65252,156 +65175,89 @@ "examples": { "default": { "value": { - "total_count": 1, - "repositories": [ + "total_count": 2, + "runners": [ { - "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 + "id": 5, + "name": "My hosted ubuntu runner", + "runner_group_id": 2, + "platform": "linux-x64", + "image": { + "id": "ubuntu-20.04", + "size": 86 }, - "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" + "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 + } ], - "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 + "last_active_on": "2022-10-09T23:39:01Z" + }, + { + "id": 7, + "name": "My hosted Windows runner", + "runner_group_id": 2, + "platform": "win-x64", + "image": { + "id": "windows-latest", + "size": 256 }, - "allow_rebase_merge": 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" + "machine_size_details": { + "id": "8-core", + "cpu_cores": 8, + "memory_gb": 32, + "storage_gb": 300 }, - "forks": 1, - "open_issues": 1, - "watchers": 1 + "status": "Ready", + "maximum_runners": 20, + "public_ip_enabled": false, + "public_ips": [], + "last_active_on": "2023-04-26T15:23:37Z" } ] } } } } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } } } }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "permissions" + "subcategory": "hosted-runners" } }, - "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", + "post": { + "summary": "Create a GitHub-hosted runner for an organization", + "description": "Creates a GitHub-hosted runner for an organization.\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "operationId": "actions/create-hosted-runner-for-org", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization" }, "parameters": [ { @@ -65414,11 +65270,6 @@ } } ], - "responses": { - "204": { - "description": "Response" - } - }, "requestBody": { "required": true, "content": { @@ -65426,26 +65277,312 @@ "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." + "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": [ - "selected_repository_ids" + "name", + "image", + "size", + "runner_group_id" ] }, "examples": { "default": { "value": { - "selected_repository_ids": [ - 32, - 42 - ] + "name": "My Hosted runner", + "image": { + "id": "ubuntu-latest", + "source": "github" + }, + "runner_group_id": 1, + "size": "4-core", + "maximum_runners": 50, + "enable_static_ip": false + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the hosted runner.", + "type": "integer", + "examples": [ + 5 + ] + }, + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "examples": [ + "my-github-hosted-runner" + ] + }, + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "examples": [ + 2 + ] + }, + "image_details": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "examples": [ + "ubuntu-20.04" + ] + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 20.04 + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ] + } + ] + }, + "machine_size_details": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", + "type": "object", + "properties": { + "id": { + "description": "The ID used for the `size` parameter when creating a new runner.", + "type": "string", + "examples": [ + "8-core" + ] + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "examples": [ + 8 + ] + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "examples": [ + 32 + ] + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "examples": [ + 300 + ] + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ], + "examples": [ + "Ready" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] + }, + "maximum_runners": { + "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", + "type": "integer", + "default": 10, + "examples": [ + 5 + ] + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "examples": [ + true + ] + }, + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", + "type": "array", + "items": { + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", + "type": "object", + "properties": { + "enabled": { + "description": "Whether public IP is enabled.", + "type": "boolean", + "examples": [ + true + ] + }, + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "examples": [ + "20.80.208.150" + ] + }, + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "examples": [ + 28 + ] + } + } + } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2022-10-09T23:39:01Z" + ] + } + }, + "required": [ + "id", + "name", + "image_details", + "machine_size_details", + "status", + "public_ip_enabled", + "platform" + ] + }, + "examples": { + "default": { + "value": { + "id": 5, + "name": "My hosted ubuntu runner", + "runner_group_id": 2, + "platform": "linux-x64", + "image": { + "id": "ubuntu-20.04", + "size": 86 + }, + "machine_size_details": { + "id": "4-core", + "cpu_cores": 4, + "memory_gb": 16, + "storage_gb": 150 + }, + "status": "Ready", + "maximum_runners": 10, + "public_ip_enabled": true, + "public_ips": [ + { + "enabled": true, + "prefix": "20.80.208.150", + "length": 31 + } + ], + "last_active_on": "2022-10-09T23:39:01Z" + } } } } @@ -65456,21 +65593,21 @@ "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", - "subcategory": "permissions" + "subcategory": "hosted-runners" } } }, - "/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", + "/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/permissions#enable-a-selected-repository-for-github-actions-in-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization" }, "parameters": [ { @@ -65481,39 +65618,113 @@ "schema": { "type": "string" } - }, - { - "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", + "examples": [ + "ubuntu-20.04" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 20.04 + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "platform", + "size_gb", + "display_name", + "source" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "id": "ubuntu-20.04", + "platform": "linux-x64", + "size_gb": 86, + "display_name": "20.04", + "source": "github" + } + } + } + } + } } }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "permissions" + "subcategory": "hosted-runners" } - }, - "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", + } + }, + "/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/permissions#disable-a-selected-repository-for-github-actions-in-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization" }, "parameters": [ { @@ -65524,41 +65735,113 @@ "schema": { "type": "string" } - }, - { - "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", + "examples": [ + "ubuntu-20.04" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 20.04 + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "platform", + "size_gb", + "display_name", + "source" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "id": "ubuntu-20.04", + "platform": "linux-x64", + "size_gb": 86, + "display_name": "20.04", + "source": "github" + } + } + } + } + } } }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "permissions" + "subcategory": "hosted-runners" } } }, - "/orgs/{org}/actions/permissions/selected-actions": { + "/orgs/{org}/actions/hosted-runners/limits": { "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", + "summary": "Get limits on GitHub-hosted runners for an organization", + "description": "Get the GitHub-hosted runners limits for an organization.", + "operationId": "actions/get-hosted-runners-limits-for-org", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-organization" }, "parameters": [ { @@ -65579,32 +65862,43 @@ "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" - } + "public_ips": { + "title": "Static public IP Limits for GitHub-hosted Hosted Runners.", + "description": "Provides details of static public IP limits for GitHub-hosted Hosted Runners", + "type": "object", + "properties": { + "maximum": { + "type": "integer", + "description": "The maximum number of static public IP addresses that can be used for Hosted Runners.", + "examples": [ + 50 + ] + }, + "current_usage": { + "type": "integer", + "description": "The current number of static public IP addresses in use by Hosted Runners.", + "examples": [ + 17 + ] + } + }, + "required": [ + "maximum", + "current_usage" + ] } - } + }, + "required": [ + "public_ips" + ] }, "examples": { "default": { "value": { - "github_owned_allowed": true, - "verified_allowed": false, - "patterns_allowed": [ - "monalisa/octocat@*", - "docker/*" - ] + "public_ips": { + "current_usage": 17, + "maximum": 50 + } } } } @@ -65613,22 +65907,24 @@ } }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "permissions" + "subcategory": "hosted-runners" } - }, - "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", + } + }, + "/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/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization" }, "parameters": [ { @@ -65642,43 +65938,74 @@ } ], "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" + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "machine_specs" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "machine_specs": { + "type": "array", + "items": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", + "type": "object", + "properties": { + "id": { + "description": "The ID used for the `size` parameter when creating a new runner.", + "type": "string", + "examples": [ + "8-core" + ] + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "examples": [ + 8 + ] + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "examples": [ + 32 + ] + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "examples": [ + 300 + ] + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + } } } - } - }, - "examples": { - "selected_actions": { - "value": { - "github_owned_allowed": true, - "verified_allowed": false, - "patterns_allowed": [ - "monalisa/octocat@*", - "docker/*" - ] + }, + "examples": { + "default": { + "value": { + "id": "4-core", + "cpu_cores": 4, + "memory_gb": 16, + "storage_gb": 150 + } } } } @@ -65686,24 +66013,24 @@ } }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "permissions" + "subcategory": "hosted-runners" } } }, - "/orgs/{org}/actions/permissions/workflow": { + "/orgs/{org}/actions/hosted-runners/platforms": { "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.", + "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" ], - "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" + "url": "https://docs.github.com/rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-organization" }, "parameters": [ { @@ -65723,31 +66050,30 @@ "application/json": { "schema": { "type": "object", + "required": [ + "total_count", + "platforms" + ], "properties": { - "default_workflow_permissions": { - "type": "string", - "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", - "enum": [ - "read", - "write" - ] + "total_count": { + "type": "integer" }, - "can_approve_pull_request_reviews": { - "type": "boolean", - "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk." + "platforms": { + "type": "array", + "items": { + "type": "string" + } } - }, - "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 + "total_count": 1, + "platforms": [ + "linux-x64", + "win-x64" + ] } } } @@ -65759,19 +66085,21 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "permissions" + "subcategory": "hosted-runners" } - }, - "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.", + } + }, + "/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/set-github-actions-default-workflow-permissions-organization", + "operationId": "actions/get-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization" }, "parameters": [ { @@ -65781,102 +66109,15 @@ "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" + } + }, + { + "name": "hosted_runner_id", + "description": "Unique identifier of the GitHub-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" } } ], @@ -65886,161 +66127,272 @@ "content": { "application/json": { "schema": { + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", "type": "object", - "required": [ - "total_count", - "runner_groups" - ], "properties": { - "total_count": { - "type": "number" + "id": { + "description": "The unique identifier of the hosted runner.", + "type": "integer", + "examples": [ + 5 + ] }, - "runner_groups": { + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "examples": [ + "my-github-hosted-runner" + ] + }, + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "examples": [ + 2 + ] + }, + "image_details": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "examples": [ + "ubuntu-20.04" + ] + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 20.04 + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ] + } + ] + }, + "machine_size_details": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", + "type": "object", + "properties": { + "id": { + "description": "The ID used for the `size` parameter when creating a new runner.", + "type": "string", + "examples": [ + "8-core" + ] + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "examples": [ + 8 + ] + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "examples": [ + 32 + ] + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "examples": [ + 300 + ] + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ], + "examples": [ + "Ready" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] + }, + "maximum_runners": { + "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", + "type": "integer", + "default": 10, + "examples": [ + 5 + ] + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "examples": [ + true + ] + }, + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", "type": "array", "items": { + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", "type": "object", "properties": { - "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.", + "enabled": { + "description": "Whether public IP is enabled.", "type": "boolean", - "default": false + "examples": [ + true + ] }, - "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 + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "examples": [ + "20.80.208.150" + ] }, - "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.", - "examples": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - ] - } + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "examples": [ + 28 + ] } - }, - "required": [ - "id", - "name", - "visibility", - "default", - "runners_url", - "inherited", - "allows_public_repositories" - ] + } } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2022-10-09T23:39:01Z" + ] } - } + }, + "required": [ + "id", + "name", + "image_details", + "machine_size_details", + "status", + "public_ip_enabled", + "platform" + ] }, "examples": { "default": { "value": { - "total_count": 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": 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": 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 + "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" } }, - "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", + "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#create-a-self-hosted-runner-group-for-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization" }, "parameters": [ { @@ -66051,6 +66403,15 @@ "schema": { "type": "string" } + }, + { + "name": "hosted_runner_id", + "description": "Unique identifier of the GitHub-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "requestBody": { @@ -66061,78 +66422,30 @@ "type": "object", "properties": { "name": { - "description": "Name of the runner group.", + "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" }, - "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 + "runner_group_id": { + "description": "The existing runner group to add this runner to.", + "type": "integer" }, - "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.", - "examples": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - ] - } + "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" }, - "network_configuration_id": { - "description": "The identifier of a hosted compute network configuration.", - "type": "string" + "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" } - }, - "required": [ - "name" - ] + } }, "examples": { "default": { "value": { - "name": "Expensive hardware runners", - "visibility": "selected", - "selected_repository_ids": [ - 32, - 91 - ], - "runners": [ - 9, - 2 - ] + "name": "My larger runner", + "runner_group_id": 1, + "maximum_runners": 50, + "enable_static_ip": false } } } @@ -66140,98 +66453,245 @@ } }, "responses": { - "201": { + "200": { "description": "Response", "content": { "application/json": { "schema": { + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", "type": "object", "properties": { "id": { - "type": "number" + "description": "The unique identifier of the hosted runner.", + "type": "integer", + "examples": [ + 5 + ] }, "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" + "description": "The name of the hosted runner.", + "type": "string", + "examples": [ + "my-github-hosted-runner" + ] }, - "hosted_runners_url": { - "type": "string" + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "examples": [ + 2 + ] }, - "network_configuration_id": { - "description": "The identifier of a hosted compute network configuration.", - "type": "string" + "image_details": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "examples": [ + "ubuntu-20.04" + ] + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 20.04 + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ] + } + ] }, - "inherited": { - "type": "boolean" + "machine_size_details": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", + "type": "object", + "properties": { + "id": { + "description": "The ID used for the `size` parameter when creating a new runner.", + "type": "string", + "examples": [ + "8-core" + ] + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "examples": [ + 8 + ] + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "examples": [ + 32 + ] + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "examples": [ + 300 + ] + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] }, - "inherited_allows_public_repositories": { - "type": "boolean" + "status": { + "description": "The status of the runner.", + "type": "string", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ], + "examples": [ + "Ready" + ] }, - "allows_public_repositories": { - "type": "boolean" + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] }, - "workflow_restrictions_read_only": { - "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", - "type": "boolean", - "default": false + "maximum_runners": { + "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", + "type": "integer", + "default": 10, + "examples": [ + 5 + ] }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", "type": "boolean", - "default": false + "examples": [ + 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`.", + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", "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.", - "examples": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - ] + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", + "type": "object", + "properties": { + "enabled": { + "description": "Whether public IP is enabled.", + "type": "boolean", + "examples": [ + true + ] + }, + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "examples": [ + "20.80.208.150" + ] + }, + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "examples": [ + 28 + ] + } + } } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2022-10-09T23:39:01Z" + ] } }, "required": [ "id", "name", - "visibility", - "default", - "runners_url", - "inherited", - "allows_public_repositories" + "image_details", + "machine_size_details", + "status", + "public_ip_enabled", + "platform" ] }, "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" + "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 + } ], - "workflow_restrictions_read_only": false + "last_active_on": "2022-10-09T23:39:01Z" } } } @@ -66243,21 +66703,19 @@ "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "hosted-runners" } - } - }, - "/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", + }, + "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/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization" }, "parameters": [ { @@ -66270,8 +66728,8 @@ } }, { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", + "name": "hosted_runner_id", + "description": "Unique identifier of the GitHub-hosted runner.", "in": "path", "required": true, "schema": { @@ -66280,98 +66738,245 @@ } ], "responses": { - "200": { + "202": { "description": "Response", "content": { "application/json": { "schema": { + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", "type": "object", "properties": { "id": { - "type": "number" + "description": "The unique identifier of the hosted runner.", + "type": "integer", + "examples": [ + 5 + ] }, "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" + "description": "The name of the hosted runner.", + "type": "string", + "examples": [ + "my-github-hosted-runner" + ] }, - "hosted_runners_url": { - "type": "string" + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "examples": [ + 2 + ] }, - "network_configuration_id": { - "description": "The identifier of a hosted compute network configuration.", - "type": "string" + "image_details": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "examples": [ + "ubuntu-20.04" + ] + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "examples": [ + 86 + ] + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "examples": [ + 20.04 + ] + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ] + } + ] }, - "inherited": { - "type": "boolean" + "machine_size_details": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", + "type": "object", + "properties": { + "id": { + "description": "The ID used for the `size` parameter when creating a new runner.", + "type": "string", + "examples": [ + "8-core" + ] + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "examples": [ + 8 + ] + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "examples": [ + 32 + ] + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "examples": [ + 300 + ] + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] }, - "inherited_allows_public_repositories": { - "type": "boolean" + "status": { + "description": "The status of the runner.", + "type": "string", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ], + "examples": [ + "Ready" + ] }, - "allows_public_repositories": { - "type": "boolean" + "platform": { + "description": "The operating system of the image.", + "type": "string", + "examples": [ + "linux-x64" + ] }, - "workflow_restrictions_read_only": { - "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", - "type": "boolean", - "default": false + "maximum_runners": { + "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", + "type": "integer", + "default": 10, + "examples": [ + 5 + ] }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", "type": "boolean", - "default": false + "examples": [ + 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`.", + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", "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.", - "examples": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - ] + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", + "type": "object", + "properties": { + "enabled": { + "description": "Whether public IP is enabled.", + "type": "boolean", + "examples": [ + true + ] + }, + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "examples": [ + "20.80.208.150" + ] + }, + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "examples": [ + 28 + ] + } + } } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2022-10-09T23:39:01Z" + ] } }, "required": [ "id", "name", - "visibility", - "default", - "runners_url", - "inherited", - "allows_public_repositories" + "image_details", + "machine_size_details", + "status", + "public_ip_enabled", + "platform" ] }, "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" + "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 + } ], - "workflow_restrictions_read_only": false + "last_active_on": "2022-10-09T23:39:01Z" } } } @@ -66380,22 +66985,24 @@ } }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": false, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "hosted-runners" } - }, - "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", + } + }, + "/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": [ - "actions" + "oidc" ], + "operationId": "oidc/get-oidc-custom-sub-template-for-org", "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/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization" }, "parameters": [ { @@ -66406,14 +67013,69 @@ "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": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], @@ -66422,59 +67084,29 @@ "content": { "application/json": { "schema": { + "title": "Actions OIDC Subject customization", + "description": "Actions OIDC Subject customization", "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`.", + "include_claim_keys": { + "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.", "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.", - "examples": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - ] + "type": "string" } - }, - "network_configuration_id": { - "description": "The identifier of a hosted compute network configuration.", - "type": [ - "string", - "null" - ] } }, "required": [ - "name" + "include_claim_keys" ] }, "examples": { "default": { "value": { - "name": "Expensive hardware runners", - "visibility": "selected" + "include_claim_keys": [ + "repo", + "context" + ] } } } @@ -66482,98 +67114,154 @@ } }, "responses": { - "200": { - "description": "Response", + "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": { - "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": { + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "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" + "url": { + "type": "string" }, - "allows_public_repositories": { - "type": "boolean" + "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" + ] }, - "workflow_restrictions_read_only": { - "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", - "type": "boolean", - "default": false + "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`." }, - "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 + "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_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.", - "examples": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - ] - } + "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": [ - "id", - "name", - "visibility", - "default", - "runners_url", - "inherited", - "allows_public_repositories" + "enabled_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 + "enabled_repositories": "all", + "allowed_actions": "selected", + "selected_actions_url": "https://api.github.com/organizations/42/actions/permissions/selected-actions" } } } @@ -66585,19 +67273,19 @@ "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "permissions" } }, - "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", + "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/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-an-organization" }, "parameters": [ { @@ -66608,15 +67296,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": { @@ -66624,25 +67303,66 @@ "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-runner-groups" + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/runner-groups/{runner_group_id}/hosted-runners": { + "/orgs/{org}/actions/permissions/repositories": { "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": "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/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization" }, "parameters": [ { @@ -66654,15 +67374,6 @@ "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).\"", @@ -66691,396 +67402,134 @@ "type": "object", "required": [ "total_count", - "runners" + "repositories" ], "properties": { "total_count": { "type": "number" }, - "runners": { + "repositories": { "type": "array", "items": { - "title": "GitHub-hosted hosted runner", - "description": "A Github-hosted hosted runner.", + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", "properties": { "id": { - "description": "The unique identifier of the hosted runner.", + "description": "Unique identifier of the repository", "type": "integer", + "format": "int64", "examples": [ - 5 + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { - "description": "The name of the hosted runner.", + "description": "The name of the repository.", "type": "string", "examples": [ - "my-github-hosted-runner" + "Team Environment" ] }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", + "full_name": { + "type": "string", "examples": [ - 2 + "octocat/Hello-World" ] }, - "image_details": { + "license": { "anyOf": [ { "type": "null" }, { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", + "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", "examples": [ - "ubuntu-20.04" + "mit" ] }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", + "name": { + "type": "string", "examples": [ - 86 + "MIT License" ] }, - "display_name": { - "description": "Display name for this image.", - "type": "string", + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", "examples": [ - 20.04 + "https://api.github.com/licenses/mit" ] }, - "source": { - "description": "The image provider.", + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { "type": "string", - "enum": [ - "github", - "partner", - "custom" + "examples": [ + "MDc6TGljZW5zZW1pdA==" ] + }, + "html_url": { + "type": "string", + "format": "uri" } }, "required": [ - "id", - "size_gb", - "display_name", - "source" + "key", + "name", + "url", + "spdx_id", + "node_id" ] } ] }, - "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.", - "type": "string", - "examples": [ - "8-core" - ] + "admin": { + "type": "boolean" }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "examples": [ - 8 - ] + "pull": { + "type": "boolean" }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "examples": [ - 32 - ] + "triage": { + "type": "boolean" }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "examples": [ - 300 - ] + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" } }, "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ], - "examples": [ - "Ready" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "examples": [ - "linux-x64" - ] - }, - "maximum_runners": { - "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", - "type": "integer", - "default": 10, - "examples": [ - 5 - ] - }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", - "type": "boolean", - "examples": [ - true - ] - }, - "public_ips": { - "description": "The public IP ranges when public IP is enabled for the hosted runners.", - "type": "array", - "items": { - "title": "Public IP for a GitHub-hosted larger runners.", - "description": "Provides details of Public IP for a GitHub-hosted larger runners", - "type": "object", - "properties": { - "enabled": { - "description": "Whether public IP is enabled.", - "type": "boolean", - "examples": [ - true - ] - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "examples": [ - "20.80.208.150" - ] - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "examples": [ - 28 - ] - } - } - } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2022-10-09T23:39:01Z" - ] - } - }, - "required": [ - "id", - "name", - "image_details", - "machine_size_details", - "status", - "public_ip_enabled", - "platform" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "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", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" + "admin", + "pull", + "push" ] }, "owner": { @@ -67252,6 +67701,8 @@ ] }, "private": { + "description": "Whether the repository is private or public.", + "default": false, "type": "boolean" }, "html_url": { @@ -67388,7 +67839,10 @@ ] }, "git_url": { - "type": "string" + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] }, "issue_comment_url": { "type": "string", @@ -67459,7 +67913,10 @@ ] }, "ssh_url": { - "type": "string" + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] }, "stargazers_url": { "type": "string", @@ -67509,12 +67966,19 @@ ] }, "clone_url": { - "type": "string" + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] }, "mirror_url": { "type": [ "string", "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { @@ -67525,12 +67989,20 @@ ] }, "svn_url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] }, "homepage": { "type": [ "string", "null" + ], + "format": "uri", + "examples": [ + "https://github.com" ] }, "language": { @@ -67540,26 +68012,50 @@ ] }, "forks_count": { - "type": "integer" + "type": "integer", + "examples": [ + 9 + ] }, "stargazers_count": { - "type": "integer" + "type": "integer", + "examples": [ + 80 + ] }, "watchers_count": { - "type": "integer" + "type": "integer", + "examples": [ + 80 + ] }, "size": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" + "type": "integer", + "examples": [ + 108 + ] }, "default_branch": { - "type": "string" + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] }, "open_issues_count": { - "type": "integer" + "type": "integer", + "examples": [ + 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", + "examples": [ + true + ] }, "topics": { "type": "array", @@ -67568,30 +68064,61 @@ } }, "has_issues": { - "type": "boolean" + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_projects": { - "type": "boolean" + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_wiki": { - "type": "boolean" + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_pages": { "type": "boolean" }, "has_downloads": { - "type": "boolean" + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] }, "has_discussions": { - "type": "boolean" + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] }, "archived": { + "description": "Whether the repository is archived.", + "default": false, "type": "boolean" }, "disabled": { - "type": "boolean" + "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": { @@ -67624,238 +68151,136 @@ "2011-01-26T19:14:43Z" ] }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", "examples": [ - "admin" + true ] }, "temp_clone_token": { "type": "string" }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, - "network_count": { - "type": "integer" + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# 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", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer", + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", "examples": [ - 0 + false ] }, - "open_issues": { - "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", "examples": [ - 0 + false ] }, - "watchers": { - "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 + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", "examples": [ - 0 + true ] }, "allow_forking": { + "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { - "type": "boolean", + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", "examples": [ - false + "\"2020-07-09T00:17:42Z\"" ] }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], + "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": { - "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": [ @@ -67904,7 +68329,34 @@ "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" ] } } @@ -68017,132 +68469,13 @@ "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 - }, + "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": { @@ -68150,7 +68483,8 @@ "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==" + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://github.com/licenses/mit" }, "forks": 1, "open_issues": 1, @@ -68168,19 +68502,19 @@ "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "permissions" } }, "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", + "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/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization" }, "parameters": [ { @@ -68191,17 +68525,13 @@ "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" + } + }, "requestBody": { "required": true, "content": { @@ -68210,7 +68540,7 @@ "type": "object", "properties": { "selected_repository_ids": { - "description": "List of repository IDs that can access the runner group.", + "description": "List of repository IDs to enable for GitHub Actions.", "type": "array", "items": { "type": "integer", @@ -68227,7 +68557,7 @@ "value": { "selected_repository_ids": [ 32, - 91 + 42 ] } } @@ -68235,30 +68565,25 @@ } } }, - "responses": { - "204": { - "description": "Response" - } - }, "x-github": { "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": { + "/orgs/{org}/actions/permissions/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", + "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/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization" }, "parameters": [ { @@ -68270,15 +68595,6 @@ "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.", @@ -68298,19 +68614,19 @@ "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "permissions" } }, "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", + "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/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization" }, "parameters": [ { @@ -68322,15 +68638,6 @@ "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.", @@ -68350,21 +68657,21 @@ "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": { + "/orgs/{org}/actions/permissions/selected-actions": { "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 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/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization" }, "parameters": [ { @@ -68375,33 +68682,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": { @@ -68411,100 +68691,20 @@ "application/json": { "schema": { "type": "object", - "required": [ - "total_count", - "runners" - ], "properties": { - "total_count": { - "type": "number" + "github_owned_allowed": { + "type": "boolean", + "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." }, - "runners": { + "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": { - "title": "Self hosted runners", - "description": "A self hosted runner", - "type": "object", - "properties": { - "id": { - "description": "The ID of the runner.", - "type": "integer", - "examples": [ - 5 - ] - }, - "runner_group_id": { - "description": "The ID of the runner group.", - "type": "integer", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the runner.", - "type": "string", - "examples": [ - "iMac" - ] - }, - "os": { - "description": "The Operating System of the runner.", - "type": "string", - "examples": [ - "macos" - ] - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "examples": [ - "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" - ] + "type": "string" } } } @@ -68512,76 +68712,16 @@ "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" - } - ] - } + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" ] } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } } } }, @@ -68589,19 +68729,19 @@ "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "permissions" } }, "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", + "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/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization" }, "parameters": [ { @@ -68612,43 +68752,45 @@ "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" + } + }, "requestBody": { - "required": true, + "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { - "runners": { - "description": "List of runner IDs to add to the runner group.", + "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": "integer", - "description": "Unique identifier of the runner." + "type": "string" } } - }, - "required": [ - "runners" - ] + } }, "examples": { - "default": { + "selected_actions": { "value": { - "runners": [ - 9, - 2 + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" ] } } @@ -68656,30 +68798,25 @@ } } }, - "responses": { - "204": { - "description": "Response" - } - }, "x-github": { "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "permissions" } } }, - "/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/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/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-an-organization" }, "parameters": [ { @@ -68690,48 +68827,64 @@ "schema": { "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.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { - "204": { - "description": "Response" + "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": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "permissions" } }, - "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", + "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/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-an-organization" }, "parameters": [ { @@ -68742,60 +68895,67 @@ "schema": { "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.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { "204": { - "description": "Response" + "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": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/runners": { + "/orgs/{org}/actions/runner-groups": { "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.", + "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" ], - "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/self-hosted-runner-groups#list-self-hosted-runner-groups-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.", @@ -68822,6 +68982,15 @@ "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": { @@ -68833,97 +69002,82 @@ "type": "object", "required": [ "total_count", - "runners" + "runner_groups" ], "properties": { "total_count": { - "type": "integer" + "type": "number" }, - "runners": { + "runner_groups": { "type": "array", "items": { - "title": "Self hosted runners", - "description": "A self hosted runner", "type": "object", "properties": { "id": { - "description": "The ID of the runner.", - "type": "integer", - "examples": [ - 5 - ] - }, - "runner_group_id": { - "description": "The ID of the runner group.", - "type": "integer", - "examples": [ - 1 - ] + "type": "number" }, "name": { - "description": "The name of the runner.", - "type": "string", - "examples": [ - "iMac" - ] + "type": "string" }, - "os": { - "description": "The Operating System of the runner.", - "type": "string", - "examples": [ - "macos" - ] + "visibility": { + "type": "string" }, - "status": { - "description": "The status of the runner.", - "type": "string", - "examples": [ - "online" - ] + "default": { + "type": "boolean" }, - "busy": { + "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" }, - "labels": { + "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": { - "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" + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "examples": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@main" ] } - }, - "ephemeral": { - "type": "boolean" } }, "required": [ "id", "name", - "os", - "status", - "busy", - "labels" + "visibility", + "default", + "runners_url", + "inherited", + "allows_public_repositories" ] } } @@ -68932,98 +69086,291 @@ "examples": { "default": { "value": { - "total_count": 2, - "runners": [ + "total_count": 3, + "runner_groups": [ { - "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": 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": 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": 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 } ] } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", + } + } + }, + "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.", + "examples": [ + "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": "string" + "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.", + "examples": [ + "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": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "self-hosted-runner-groups" } } }, - "/orgs/{org}/actions/runners/downloads": { + "/orgs/{org}/actions/runner-groups/{runner_group_id}": { "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 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" ], - "operationId": "actions/list-runner-applications-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/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization" }, "parameters": [ { @@ -69034,6 +69381,15 @@ "schema": { "type": "string" } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "responses": { @@ -69042,74 +69398,94 @@ "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": { - "type": "string" - } + "type": "object", + "properties": { + "id": { + "type": "number" }, - "required": [ - "os", - "architecture", - "download_url", - "filename" - ] - } + "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.", + "examples": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + ] + } + } + }, + "required": [ + "id", + "name", + "visibility", + "default", + "runners_url", + "inherited", + "allows_public_repositories" + ] }, "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": { + "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 + } } } } @@ -69117,24 +69493,22 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "self-hosted-runner-groups" } - } - }, - "/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.", + }, + "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" ], - "operationId": "actions/generate-runner-jitconfig-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/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization" }, "parameters": [ { @@ -69145,6 +69519,15 @@ "schema": { "type": "string" } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "requestBody": { @@ -69153,48 +69536,58 @@ "application/json": { "schema": { "type": "object", - "required": [ - "name", - "runner_group_id", - "labels" - ], "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", - "description": "The name of the new runner." + "enum": [ + "selected", + "all", + "private" + ] }, - "runner_group_id": { - "type": "integer", - "description": "The ID of the runner group to register the runner to." + "allows_public_repositories": { + "description": "Whether the runner group can be used by `public` repositories.", + "type": "boolean", + "default": false }, - "labels": { + "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", - "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." + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "examples": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + ] + } }, - "work_folder": { - "type": "string", - "description": "The working directory to be used for job execution, relative to the runner install directory.", - "default": "_work" + "network_configuration_id": { + "description": "The identifier of a hosted compute network configuration.", + "type": [ + "string", + "null" + ] } - } + }, + "required": [ + "name" + ] }, "examples": { "default": { "value": { - "name": "New runner", - "runner_group_id": 1, - "labels": [ - "self-hosted", - "X64", - "macOS", - "no-gpu" - ], - "work_folder": "_work" + "name": "Expensive hardware runners", + "visibility": "selected" } } } @@ -69202,223 +69595,98 @@ } }, "responses": { - "201": { + "200": { "description": "Response", "content": { "application/json": { "schema": { "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", - "examples": [ - 5 - ] - }, - "runner_group_id": { - "description": "The ID of the runner group.", - "type": "integer", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the runner.", - "type": "string", - "examples": [ - "iMac" - ] - }, - "os": { - "description": "The Operating System of the runner.", - "type": "string", - "examples": [ - "macos" - ] - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "examples": [ - "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" - ] + "id": { + "type": "number" }, - "encoded_jit_config": { - "type": "string", - "description": "The base64 encoded runner configuration." - } - } - }, - "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" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { + "name": { "type": "string" }, - "documentation_url": { + "visibility": { "type": "string" }, - "url": { + "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" }, - "status": { + "runners_url": { "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": { + }, + "hosted_runners_url": { "type": "string" }, - "documentation_url": { + "network_configuration_id": { + "description": "The identifier of a hosted compute network configuration.", "type": "string" }, - "errors": { + "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" + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "examples": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + ] } } - } - } - } - } - }, - "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" + }, + "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 } } } @@ -69427,24 +69695,67 @@ } }, "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-runners" + "subcategory": "self-hosted-runner-groups" } } }, - "/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/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" ], - "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/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization" }, "parameters": [ { @@ -69455,1049 +69766,350 @@ "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": { - "201": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Authentication Token", - "description": "Authentication Token", "type": "object", + "required": [ + "total_count", + "runners" + ], "properties": { - "token": { - "description": "The token used for authentication", - "type": "string", - "examples": [ - "v1.1f699f1069f60xxx" - ] - }, - "expires_at": { - "description": "The time this token expires", - "type": "string", - "format": "date-time", - "examples": [ - "2016-07-11T22:14:10Z" - ] - }, - "permissions": { - "type": "object", - "examples": [ - { - "issues": "read", - "deployments": "write" - } - ] + "total_count": { + "type": "number" }, - "repositories": { - "description": "The repositories this token has access to", + "runners": { "type": "array", "items": { - "title": "Repository", - "description": "A repository on GitHub.", + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", "type": "object", "properties": { "id": { - "description": "Unique identifier of the repository", + "description": "The unique identifier of the hosted runner.", "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + 5 ] }, "name": { - "description": "The name of the repository.", + "description": "The name of the hosted runner.", "type": "string", "examples": [ - "Team Environment" + "my-github-hosted-runner" ] }, - "full_name": { - "type": "string", + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", "examples": [ - "octocat/Hello-World" + 2 ] }, - "license": { + "image_details": { "anyOf": [ { "type": "null" }, { - "title": "License Simple", - "description": "License Simple", + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", "type": "object", "properties": { - "key": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", "type": "string", "examples": [ - "mit" + "ubuntu-20.04" ] }, - "name": { - "type": "string", + "size_gb": { + "description": "Image size in GB.", + "type": "integer", "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" + 86 ] }, - "node_id": { + "display_name": { + "description": "Display name for this image.", "type": "string", "examples": [ - "MDc6TGljZW5zZW1pdA==" + 20.04 ] }, - "html_url": { + "source": { + "description": "The image provider.", "type": "string", - "format": "uri" + "enum": [ + "github", + "partner", + "custom" + ] } }, "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" + "id", + "size_gb", + "display_name", + "source" ] } ] }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", + "machine_size_details": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { + "description": "The ID used for the `size` parameter when creating a new runner.", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "8-core" ] }, - "type": { - "type": "string", + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", "examples": [ - "User" + 8 ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", "examples": [ - "\"2020-07-09T00:17:55Z\"" + 32 ] }, - "user_view_type": { - "type": "string", + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", "examples": [ - "public" + 300 ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" + "cpu_cores", + "memory_gb", + "storage_gb" ] }, - "svn_url": { + "status": { + "description": "The status of the runner.", "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", "examples": [ - 108 + "Ready" ] }, - "default_branch": { - "description": "The default branch of the repository.", + "platform": { + "description": "The operating system of the image.", "type": "string", "examples": [ - "master" + "linux-x64" ] }, - "open_issues_count": { + "maximum_runners": { + "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", "type": "integer", + "default": 10, "examples": [ - 0 + 5 ] }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", "type": "boolean", "examples": [ true ] }, - "topics": { + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", "type": "array", "items": { - "type": "string" + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", + "type": "object", + "properties": { + "enabled": { + "description": "Whether public IP is enabled.", + "type": "boolean", + "examples": [ + true + ] + }, + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "examples": [ + "20.80.208.150" + ] + }, + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "examples": [ + 28 + ] + } + } } }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", "type": [ "string", "null" ], "format": "date-time", "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" + "2022-10-09T23:39:01Z" ] - }, - "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" + "image_details", + "machine_size_details", + "status", + "public_ip_enabled", + "platform" ] } - }, - "single_file": { - "type": [ - "string", - "null" - ], - "examples": [ - "config.yaml" - ] - }, - "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": 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": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "self-hosted-runner-groups" } } }, - "/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/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" ], - "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/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization" }, "parameters": [ { @@ -70508,56 +70120,62 @@ "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": { - "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", - "examples": [ - "v1.1f699f1069f60xxx" - ] - }, - "expires_at": { - "description": "The time this token expires", - "type": "string", - "format": "date-time", - "examples": [ - "2016-07-11T22:14:10Z" - ] - }, - "permissions": { - "type": "object", - "examples": [ - { - "issues": "read", - "deployments": "write" - } - ] + "total_count": { + "type": "number" }, "repositories": { - "description": "The repositories this token has access to", "type": "array", "items": { - "title": "Repository", - "description": "A repository on GitHub.", + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { "id": { - "description": "Unique identifier of the repository", "type": "integer", "format": "int64", "examples": [ - 42 + 1296269 ] }, "node_id": { @@ -70567,10 +70185,9 @@ ] }, "name": { - "description": "The name of the repository.", "type": "string", "examples": [ - "Team Environment" + "Hello-World" ] }, "full_name": { @@ -70579,96 +70196,6 @@ "octocat/Hello-World" ] }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, "owner": { "title": "Simple User", "description": "A GitHub user.", @@ -70838,8 +70365,6 @@ ] }, "private": { - "description": "Whether the repository is private or public.", - "default": false, "type": "boolean" }, "html_url": { @@ -70976,10 +70501,7 @@ ] }, "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] + "type": "string" }, "issue_comment_url": { "type": "string", @@ -71050,10 +70572,7 @@ ] }, "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] + "type": "string" }, "stargazers_url": { "type": "string", @@ -71103,19 +70622,12 @@ ] }, "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] + "type": "string" }, "mirror_url": { "type": [ "string", "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { @@ -71126,20 +70638,12 @@ ] }, "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] + "type": "string" }, "homepage": { "type": [ "string", "null" - ], - "format": "uri", - "examples": [ - "https://github.com" ] }, "language": { @@ -71149,50 +70653,26 @@ ] }, "forks_count": { - "type": "integer", - "examples": [ - 9 - ] + "type": "integer" }, "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] + "type": "integer" }, "watchers_count": { - "type": "integer", - "examples": [ - 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", - "examples": [ - 108 - ] + "type": "integer" }, "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] + "type": "string" }, "open_issues_count": { - "type": "integer", - "examples": [ - 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", - "examples": [ - true - ] + "type": "boolean" }, "topics": { "type": "array", @@ -71201,61 +70681,30 @@ } }, "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] + "type": "boolean" }, "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] + "type": "boolean" }, "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] + "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] + "type": "boolean" }, "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - 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": { @@ -71288,136 +70737,238 @@ "2011-01-26T19:14:43Z" ] }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", "examples": [ - true + "admin" ] }, "temp_clone_token": { "type": "string" }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] + "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", - "examples": [ - 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", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# 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", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" + "license": { + "type": [ + "object", + "null" ], - "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." + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } }, - "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", + "examples": [ + 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", + "examples": [ + 0 + ] }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", + "watchers": { + "type": "integer", "examples": [ - true + 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", + "type": "boolean", "examples": [ - "\"2020-07-09T00:17:42Z\"" + false ] }, - "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", + "security_and_analysis": { + "type": [ + "object", + "null" + ], "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": [ @@ -71466,65 +71017,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", - "null" - ], - "examples": [ - "config.yaml" - ] - }, - "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" + "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 + }, + "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 + } + ] } } } @@ -71533,24 +71278,100 @@ } }, "x-github": { + "enabledForGitHubApps": true, "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + }, + "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" + ], + "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" + }, + "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": { + "selected_repository_ids": { + "description": "List of repository IDs that can access the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." + } + } + }, + "required": [ + "selected_repository_ids" + ] + }, + "examples": { + "default": { + "value": { + "selected_repository_ids": [ + 32, + 91 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "self-hosted-runner-groups" } } }, - "/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.", + "/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" ], - "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" + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization" }, "parameters": [ { @@ -71563,8 +71384,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": { @@ -71573,150 +71403,27 @@ } ], "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", - "examples": [ - 5 - ] - }, - "runner_group_id": { - "description": "The ID of the runner group.", - "type": "integer", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the runner.", - "type": "string", - "examples": [ - "iMac" - ] - }, - "os": { - "description": "The Operating System of the runner.", - "type": "string", - "examples": [ - "macos" - ] - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "examples": [ - "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" - }, - { - "id": 21, - "name": "no-gpu", - "type": "custom" - } - ] - } - } - } - } - } + "204": { + "description": "Response" } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "self-hosted-runner-groups" } }, "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.", + "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/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" + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization" }, "parameters": [ { @@ -71729,8 +71436,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": { @@ -71741,57 +71457,27 @@ "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" - } - } - } - } - } - } } }, "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": { + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": { "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.", + "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" ], - "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#list-self-hosted-runners-in-a-group-for-an-organization" }, "parameters": [ { @@ -71804,192 +71490,33 @@ } }, { - "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" } - } - ], - "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" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "self-hosted-runners" - } - }, - "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": [ - "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" - }, - "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": "runner_id", - "description": "Unique identifier of the self-hosted runner.", - "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 } } ], - "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": { "200": { "description": "Response", @@ -71999,38 +71526,97 @@ "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." + "examples": [ + 5 + ] + }, + "runner_group_id": { + "description": "The ID of the runner group.", + "type": "integer", + "examples": [ + 1 + ] }, "name": { + "description": "The name of the runner.", "type": "string", - "description": "Name of the label." + "examples": [ + "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" + "examples": [ + "macos" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "examples": [ + "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" ] } } @@ -72039,109 +71625,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": [ { @@ -72154,8 +71727,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": { @@ -72169,27 +71742,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 ] } } @@ -72198,157 +71770,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": [ { @@ -72360,6 +71804,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.", @@ -72371,124 +71824,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": [ { @@ -72501,8 +71857,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": { @@ -72510,171 +71866,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.", @@ -72712,56 +71946,97 @@ "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": { - "name": { - "description": "The name of the secret.", - "type": "string", + "id": { + "description": "The ID of the runner.", + "type": "integer", "examples": [ - "SECRET_TOKEN" + 5 ] }, - "created_at": { - "type": "string", - "format": "date-time" + "runner_group_id": { + "description": "The ID of the runner group.", + "type": "integer", + "examples": [ + 1 + ] }, - "updated_at": { + "name": { + "description": "The name of the runner.", "type": "string", - "format": "date-time" + "examples": [ + "iMac" + ] }, - "visibility": { - "description": "Visibility of a secret", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" + "os": { + "description": "The Operating System of the runner.", + "type": "string", + "examples": [ + "macos" + ] }, - "selected_repositories_url": { + "status": { + "description": "The status of the runner.", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/organizations/org/secrets/my_secret/repositories" + "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", - "created_at", - "updated_at", - "visibility" + "os", + "status", + "busy", + "labels" ] } } @@ -72770,26 +72045,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" + } + ] } ] } @@ -72811,21 +72122,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": [ { @@ -72844,60 +72155,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", - "examples": [ - "1234567" - ] - }, - "key": { - "description": "The Base64 encoded public key.", - "type": "string", - "examples": [ - "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" - ] - }, - "id": { - "type": "integer", - "examples": [ - 2 - ] - }, - "url": { - "type": "string", - "examples": [ - "https://api.github.com/user/keys/2" - ] - }, - "title": { - "type": "string", - "examples": [ - "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", - "examples": [ - "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" + } + ] } } } @@ -72908,123 +72233,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.", - "type": "string", - "examples": [ - "SECRET_TOKEN" - ] - }, - "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", - "examples": [ - "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": [ { @@ -73035,15 +72258,6 @@ "schema": { "type": "string" } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } } ], "requestBody": { @@ -73052,49 +72266,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" } } } @@ -73103,90 +72316,248 @@ }, "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", + "examples": [ + 5 + ] + }, + "runner_group_id": { + "description": "The ID of the runner group.", + "type": "integer", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the runner.", + "type": "string", + "examples": [ + "iMac" + ] + }, + "os": { + "description": "The Operating System of the runner.", + "type": "string", + "examples": [ + "macos" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "examples": [ + "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": [ { @@ -73197,62 +72568,56 @@ "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", + "examples": [ + "v1.1f699f1069f60xxx" + ] + }, + "expires_at": { + "description": "The time this token expires", + "type": "string", + "format": "date-time", + "examples": [ + "2016-07-11T22:14:10Z" + ] + }, + "permissions": { + "type": "object", + "examples": [ + { + "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", "type": "integer", "format": "int64", "examples": [ - 1296269 + 42 ] }, "node_id": { @@ -73262,9 +72627,10 @@ ] }, "name": { + "description": "The name of the repository.", "type": "string", "examples": [ - "Hello-World" + "Team Environment" ] }, "full_name": { @@ -73273,6 +72639,96 @@ "octocat/Hello-World" ] }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, "owner": { "title": "Simple User", "description": "A GitHub user.", @@ -73442,6 +72898,8 @@ ] }, "private": { + "description": "Whether the repository is private or public.", + "default": false, "type": "boolean" }, "html_url": { @@ -73578,7 +73036,10 @@ ] }, "git_url": { - "type": "string" + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] }, "issue_comment_url": { "type": "string", @@ -73649,7 +73110,10 @@ ] }, "ssh_url": { - "type": "string" + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] }, "stargazers_url": { "type": "string", @@ -73699,12 +73163,19 @@ ] }, "clone_url": { - "type": "string" + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] }, "mirror_url": { "type": [ "string", "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { @@ -73715,12 +73186,20 @@ ] }, "svn_url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] }, "homepage": { "type": [ "string", "null" + ], + "format": "uri", + "examples": [ + "https://github.com" ] }, "language": { @@ -73730,26 +73209,50 @@ ] }, "forks_count": { - "type": "integer" + "type": "integer", + "examples": [ + 9 + ] }, "stargazers_count": { - "type": "integer" + "type": "integer", + "examples": [ + 80 + ] }, "watchers_count": { - "type": "integer" + "type": "integer", + "examples": [ + 80 + ] }, "size": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" + "type": "integer", + "examples": [ + 108 + ] }, "default_branch": { - "type": "string" + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] }, "open_issues_count": { - "type": "integer" + "type": "integer", + "examples": [ + 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", + "examples": [ + true + ] }, "topics": { "type": "array", @@ -73758,30 +73261,61 @@ } }, "has_issues": { - "type": "boolean" + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_projects": { - "type": "boolean" + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_wiki": { - "type": "boolean" + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_pages": { "type": "boolean" }, "has_downloads": { - "type": "boolean" + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] }, "has_discussions": { - "type": "boolean" + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] }, "archived": { + "description": "Whether the repository is archived.", + "default": false, "type": "boolean" }, "disabled": { - "type": "boolean" + "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": { @@ -73814,238 +73348,136 @@ "2011-01-26T19:14:43Z" ] }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", "examples": [ - "admin" + true ] }, "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", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# 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", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true ] }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - } + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] }, - "forks": { - "type": "integer", + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", "examples": [ - 0 + false ] }, - "open_issues": { - "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", "examples": [ - 0 + false ] }, - "watchers": { - "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 + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", "examples": [ - 0 + true ] }, "allow_forking": { + "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { - "type": "boolean", + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", "examples": [ - false + "\"2020-07-09T00:17:42Z\"" ] }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], + "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": { - "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": [ @@ -74094,829 +73526,91 @@ "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.", - "type": "string", - "examples": [ - "USERNAME" - ] - }, - "value": { - "description": "The value of the variable.", - "type": "string", - "examples": [ - "octocat" - ] - }, - "created_at": { - "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time", - "examples": [ - "2019-01-24T22:45:36.000Z" - ] - }, - "updated_at": { - "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time", - "examples": [ - "2019-01-24T22:45:36.000Z" - ] - }, - "visibility": { - "description": "Visibility of a variable", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" - }, - "selected_repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "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.", - "type": "string", - "examples": [ - "USERNAME" - ] - }, - "value": { - "description": "The value of the variable.", - "type": "string", - "examples": [ - "octocat" - ] }, - "created_at": { - "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time", + "single_file": { + "type": [ + "string", + "null" + ], "examples": [ - "2019-01-24T22:45:36.000Z" + "config.yaml" ] }, - "updated_at": { - "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", "type": "string", - "format": "date-time", - "examples": [ - "2019-01-24T22:45:36.000Z" - ] - }, - "visibility": { - "description": "Visibility of a variable", "enum": [ "all", - "private", "selected" - ], - "type": "string" - }, - "selected_repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "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": [ { @@ -74927,62 +73621,56 @@ "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", + "examples": [ + "v1.1f699f1069f60xxx" + ] + }, + "expires_at": { + "description": "The time this token expires", + "type": "string", + "format": "date-time", + "examples": [ + "2016-07-11T22:14:10Z" + ] + }, + "permissions": { + "type": "object", + "examples": [ + { + "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", "type": "integer", "format": "int64", "examples": [ - 1296269 + 42 ] }, "node_id": { @@ -74992,9 +73680,10 @@ ] }, "name": { + "description": "The name of the repository.", "type": "string", "examples": [ - "Hello-World" + "Team Environment" ] }, "full_name": { @@ -75003,6 +73692,96 @@ "octocat/Hello-World" ] }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, "owner": { "title": "Simple User", "description": "A GitHub user.", @@ -75172,6 +73951,8 @@ ] }, "private": { + "description": "Whether the repository is private or public.", + "default": false, "type": "boolean" }, "html_url": { @@ -75308,7 +74089,10 @@ ] }, "git_url": { - "type": "string" + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] }, "issue_comment_url": { "type": "string", @@ -75379,7 +74163,10 @@ ] }, "ssh_url": { - "type": "string" + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] }, "stargazers_url": { "type": "string", @@ -75429,12 +74216,19 @@ ] }, "clone_url": { - "type": "string" + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] }, "mirror_url": { "type": [ "string", "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { @@ -75445,12 +74239,20 @@ ] }, "svn_url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] }, "homepage": { "type": [ "string", "null" + ], + "format": "uri", + "examples": [ + "https://github.com" ] }, "language": { @@ -75460,26 +74262,50 @@ ] }, "forks_count": { - "type": "integer" + "type": "integer", + "examples": [ + 9 + ] }, "stargazers_count": { - "type": "integer" + "type": "integer", + "examples": [ + 80 + ] }, "watchers_count": { - "type": "integer" + "type": "integer", + "examples": [ + 80 + ] }, "size": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" + "type": "integer", + "examples": [ + 108 + ] }, "default_branch": { - "type": "string" + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] }, "open_issues_count": { - "type": "integer" + "type": "integer", + "examples": [ + 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", + "examples": [ + true + ] }, "topics": { "type": "array", @@ -75488,30 +74314,61 @@ } }, "has_issues": { - "type": "boolean" + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_projects": { - "type": "boolean" + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_wiki": { - "type": "boolean" + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_pages": { "type": "boolean" }, "has_downloads": { - "type": "boolean" + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] }, "has_discussions": { - "type": "boolean" + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] }, "archived": { + "description": "Whether the repository is archived.", + "default": false, "type": "boolean" }, "disabled": { - "type": "boolean" + "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": { @@ -75544,238 +74401,136 @@ "2011-01-26T19:14:43Z" ] }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", "examples": [ - "admin" + true ] }, "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", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# 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", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true ] }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - } + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] }, - "forks": { - "type": "integer", + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", "examples": [ - 0 + false ] }, - "open_issues": { - "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", "examples": [ - 0 + false ] }, - "watchers": { - "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 + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", "examples": [ - 0 + true ] }, "allow_forking": { + "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { - "type": "boolean", + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", "examples": [ - false + "\"2020-07-09T00:17:42Z\"" ] }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], + "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": { - "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": [ @@ -75824,114 +74579,91 @@ "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", + "null" + ], + "examples": [ + "config.yaml" + ] + }, + "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": [ { @@ -75944,73 +74676,160 @@ } }, { - "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", + "examples": [ + 5 + ] + }, + "runner_group_id": { + "description": "The ID of the runner group.", + "type": "integer", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the runner.", + "type": "string", + "examples": [ + "iMac" + ] + }, + "os": { + "description": "The Operating System of the runner.", + "type": "string", + "examples": [ + "macos" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "examples": [ + "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": [ { @@ -76023,16 +74842,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": { @@ -76044,27 +74855,56 @@ "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": [ + "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": "self-hosted-runners" + } + } + }, + "/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": [ { @@ -76077,16 +74917,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": { @@ -76095,68 +74927,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" } } ], @@ -76166,42 +75075,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" - } } } } @@ -76214,200 +75110,69 @@ "application/json": { "schema": { "type": "object", + "required": [ + "total_count", + "labels" + ], "properties": { - "attestations_subject_digests": { - "type": "object", - "additionalProperties": { - "type": [ - "array", - "null" - ], - "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" } ] } @@ -76415,27 +75180,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": [ { @@ -76446,6 +75265,15 @@ "schema": { "type": "string" } + }, + { + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "requestBody": { @@ -76454,58 +75282,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" ] } } @@ -76515,7 +75312,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", @@ -76542,27 +75413,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": [ { @@ -76575,22 +75474,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", @@ -76622,22 +75586,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": [ { @@ -76650,24 +75614,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": { @@ -76692,14 +75736,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" @@ -76707,11 +75755,11 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "errors": { + "type": "array", + "items": { + "type": "string" + } } } } @@ -76722,51 +75770,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.", @@ -76777,22 +75798,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 } } ], @@ -76803,38 +75823,59 @@ "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.", + "type": "string", + "examples": [ + "SECRET_TOKEN" + ] }, - "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", + "examples": [ + "https://api.github.com/organizations/org/secrets/my_secret/repositories" + ] } - } + }, + "required": [ + "name", + "created_at", + "updated_at", + "visibility" + ] } } } @@ -76842,156 +75883,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": [ { @@ -77002,24 +75949,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": { @@ -77028,200 +75957,60 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + "title": "ActionsPublicKey", + "description": "The public key used for setting Actions Secrets.", + "type": "object", + "properties": { + "key_id": { + "description": "The identifier for the key.", + "type": "string", + "examples": [ + "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", + "examples": [ + "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" + ] + }, + "id": { + "type": "integer", + "examples": [ + 2 + ] + }, + "url": { + "type": "string", + "examples": [ + "https://api.github.com/user/keys/2" + ] + }, + "title": { + "type": "string", + "examples": [ + "ssh-rsa AAAAB3NzaC1yc2EAAA" + ] + }, + "created_at": { + "type": "string", + "examples": [ + "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" + } } } } @@ -77231,22 +76020,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": [ { @@ -77259,8 +76048,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": { @@ -77269,29 +76058,62 @@ } ], "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": { - "type": "string" + "name": { + "description": "The name of the secret.", + "type": "string", + "examples": [ + "SECRET_TOKEN" + ] }, - "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", + "examples": [ + "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" } } } @@ -77302,20 +76124,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": [ { @@ -77328,8 +76150,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": { @@ -77337,103 +76159,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", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "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": [ { @@ -77446,8 +76267,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": { @@ -77463,22 +76284,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": [ { @@ -77490,6 +76311,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).\"", @@ -77507,51 +76337,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": { @@ -77560,2040 +76345,949 @@ "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": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "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", - "null" - ] - }, - "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", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] - } - ] - } - }, - "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", - "null" - ], - "format": "date-time" - }, - "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", - "null" - ], - "format": "uri" - }, - "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 - } - ], - "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", - "null" - ], - "format": "uri" - }, - "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", + "required": [ + "total_count", + "repositories" + ], "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" + "total_count": { + "type": "integer" }, - "managers": { - "description": "The campaign managers", + "repositories": { "type": "array", "items": { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 ] }, - "login": { + "node_id": { "type": "string", "examples": [ - "octocat" + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "id": { - "type": "integer", - "format": "int64", + "name": { + "type": "string", "examples": [ - 1 + "Hello-World" ] }, - "node_id": { + "full_name": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "octocat/Hello-World" ] }, - "avatar_url": { + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "https://github.com/octocat/Hello-World" ] }, - "gravatar_id": { + "description": { "type": [ "string", "null" ], "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "This your first repo!" ] }, + "fork": { + "type": "boolean" + }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "https://api.github.com/repos/octocat/Hello-World" ] }, - "html_url": { + "archive_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/octocat" + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, - "followers_url": { + "assignees_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, - "following_url": { + "blobs_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, - "gists_url": { + "branches_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, - "starred_url": { + "collaborators_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, - "subscriptions_url": { + "comments_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, - "organizations_url": { + "commits_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, - "repos_url": { + "compare_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, - "events_url": { + "contents_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, - "received_events_url": { + "contributors_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, - "type": { + "deployments_url": { "type": "string", + "format": "uri", "examples": [ - "User" + "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { + "downloads_url": { "type": "string", + "format": "uri", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, - "user_view_type": { + "events_url": { "type": "string", + "format": "uri", "examples": [ - "public" + "http://api.github.com/repos/octocat/Hello-World/events" ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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", - "null" + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" ] }, - "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" + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, - "url": { + "git_refs_url": { "type": "string", - "format": "uri" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] }, - "html_url": { + "git_tags_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/orgs/rails/teams/core" + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, - "members_url": { + "git_url": { "type": "string" }, - "repositories_url": { + "issue_comment_url": { "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] - } - ] - } - }, - "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", - "null" - ], - "format": "date-time" - }, - "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", - "null" - ], - "format": "uri" - }, - "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": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, - "login": { + "issue_events_url": { "type": "string", "examples": [ - "octocat" + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, - "id": { - "type": "integer", - "format": "int64", + "issues_url": { + "type": "string", "examples": [ - 1 + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, - "node_id": { + "keys_url": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, - "avatar_url": { + "labels_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, - "gravatar_id": { - "type": [ - "string", - "null" - ], + "languages_url": { + "type": "string", + "format": "uri", "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "http://api.github.com/repos/octocat/Hello-World/languages" ] }, - "url": { + "merges_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "http://api.github.com/repos/octocat/Hello-World/merges" ] }, - "html_url": { + "milestones_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/octocat" + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, - "followers_url": { + "notifications_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, - "following_url": { + "pulls_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, - "gists_url": { + "releases_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, - "starred_url": { + "ssh_url": { + "type": "string" + }, + "stargazers_url": { "type": "string", + "format": "uri", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, - "subscriptions_url": { + "statuses_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, - "organizations_url": { + "subscribers_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, - "repos_url": { + "subscription_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, - "events_url": { + "tags_url": { "type": "string", + "format": "uri", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "http://api.github.com/repos/octocat/Hello-World/tags" ] }, - "received_events_url": { + "teams_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "http://api.github.com/repos/octocat/Hello-World/teams" ] }, - "type": { + "trees_url": { "type": "string", "examples": [ - "User" + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, - "site_admin": { - "type": "boolean" + "clone_url": { + "type": "string" }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" + "mirror_url": { + "type": [ + "string", + "null" ] }, - "user_view_type": { + "hooks_url": { "type": "string", + "format": "uri", "examples": [ - "public" + "http://api.github.com/repos/octocat/Hello-World/hooks" ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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": { + "svn_url": { "type": "string" }, - "slug": { - "type": "string" + "homepage": { + "type": [ + "string", + "null" + ] }, - "description": { + "language": { "type": [ "string", "null" ] }, - "privacy": { - "type": "string" + "forks_count": { + "type": "integer" }, - "notification_setting": { + "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" }, - "permission": { + "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", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, "permissions": { "type": "object", "properties": { - "pull": { + "admin": { "type": "boolean" }, - "triage": { + "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, - "maintain": { + "triage": { "type": "boolean" }, - "admin": { + "pull": { "type": "boolean" } + } + }, + "role_name": { + "type": "string", + "examples": [ + "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", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# 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", + "null" + ], + "format": "uri" + } }, "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" + "url", + "html_url", + "key", + "name" ] }, - "url": { - "type": "string", - "format": "uri" + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } }, - "html_url": { - "type": "string", - "format": "uri", + "forks": { + "type": "integer", "examples": [ - "https://github.com/orgs/rails/teams/core" + 0 ] }, - "members_url": { - "type": "string" + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] }, - "repositories_url": { - "type": "string", - "format": "uri" + "watchers": { + "type": "integer", + "examples": [ + 0 + ] }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "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": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", + "status": { "type": "string", - "examples": [ - "admin" + "enum": [ + "enabled", + "disabled" ] - }, - "privacy": { - "description": "The level of privacy this team should have", + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { "type": "string", - "examples": [ - "closed" + "enum": [ + "enabled", + "disabled" ] - }, - "notification_setting": { - "description": "The notification setting the team has set", + } + } + }, + "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", - "examples": [ - "notifications_enabled" + "enum": [ + "enabled", + "disabled" ] - }, - "html_url": { + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" + "enum": [ + "enabled", + "disabled" ] - }, - "repositories_url": { + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" + "enum": [ + "enabled", + "disabled" ] - }, - "slug": { + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { "type": "string", - "examples": [ - "justice-league" + "enum": [ + "enabled", + "disabled" ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" + "enum": [ + "enabled", + "disabled" ] } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] + } } - ] + } + }, + "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", - "null" - ], - "format": "date-time" - }, - "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", - "null" - ], - "format": "uri" - }, - "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" + ] } } } @@ -79604,20 +77298,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": [ { @@ -79630,12 +77324,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" } } ], @@ -79645,698 +77339,416 @@ "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", - "null" - ], - "format": "uri" - }, - "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 + ] } } } } } }, + "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": { - "title": "Campaign summary", - "description": "The campaign metadata and alert stats.", "type": "object", + "required": [ + "total_count", + "variables" + ], "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" + "total_count": { + "type": "integer" }, - "managers": { - "description": "The campaign managers", + "variables": { "type": "array", "items": { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Actions Variable for an Organization", + "description": "Organization variable for GitHub Actions.", "type": "object", "properties": { "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { + "description": "The name of the variable.", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "USERNAME" ] }, - "type": { + "value": { + "description": "The value of the variable.", "type": "string", "examples": [ - "User" + "octocat" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { + "created_at": { + "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", "type": "string", + "format": "date-time", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "2019-01-24T22:45:36.000Z" ] }, - "user_view_type": { + "updated_at": { + "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", "type": "string", + "format": "date-time", "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "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", - "null" + "2019-01-24T22:45:36.000Z" ] }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { + "visibility": { + "description": "Visibility of a variable", + "enum": [ + "all", + "private", + "selected" + ], "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": { + "selected_repositories_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] - } + "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", - "null" - ], - "format": "date-time" - }, - "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", - "null" - ], - "format": "uri" - }, - "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 } } } @@ -80346,20 +77758,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": [ { @@ -80372,60 +77786,89 @@ } }, { - "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": { - "type": "string" + "name": { + "description": "The name of the variable.", + "type": "string", + "examples": [ + "USERNAME" + ] }, - "documentation_url": { - "type": "string" + "value": { + "description": "The value of the variable.", + "type": "string", + "examples": [ + "octocat" + ] }, - "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.", + "type": "string", + "format": "date-time", + "examples": [ + "2019-01-24T22:45:36.000Z" + ] }, - "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.", + "type": "string", + "format": "date-time", + "examples": [ + "2019-01-24T22:45:36.000Z" + ] }, - "message": { + "visibility": { + "description": "Visibility of a variable", + "enum": [ + "all", + "private", + "selected" + ], "type": "string" }, - "documentation_url": { - "type": "string" + "selected_repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "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" } } } @@ -80436,22 +77879,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": [ { @@ -80464,42 +77905,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": { - "type": [ - "string", - "null" - ], - "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" } @@ -80521,69 +78067,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": { @@ -80592,488 +78075,43 @@ "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", - "null" - ], - "description": "State of a code scanning alert.", - "enum": [ - "open", - "dismissed", - "fixed", - null - ] - }, - "fixed_at": { - "type": [ - "string", - "null" - ], - "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 - }, - "dismissed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "dismissed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissed_reason": { - "type": [ - "string", - "null" - ], - "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", - "enum": [ - "false positive", - "won't fix", - "used in tests", - null - ] - }, - "dismissed_comment": { - "type": [ - "string", - "null" - ], - "description": "The dismissal comment associated with the dismissal of the alert.", - "maxLength": 280 - }, - "rule": { - "type": "object", - "properties": { - "id": { - "type": [ - "string", - "null" - ], - "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": { - "type": [ - "string", - "null" - ], - "description": "The severity of the alert.", - "enum": [ - "none", - "note", - "warning", - "error", - null - ] - }, - "security_severity_level": { - "type": [ - "string", - "null" - ], - "description": "The security severity of the alert.", - "enum": [ - "low", - "medium", - "high", - "critical", - null - ] - }, - "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": { - "type": [ - "array", - "null" - ], - "description": "A set of tags applicable for the rule.", - "items": { - "type": "string" - } - }, - "help": { - "type": [ - "string", - "null" - ], - "description": "Detailed documentation for the rule as GitHub Flavored Markdown." - }, - "help_uri": { - "type": [ - "string", - "null" - ], - "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": { - "type": [ - "string", - "null" - ], - "description": "The version of the tool used to generate the code scanning analysis." - }, - "guid": { - "type": [ - "string", - "null" - ], - "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", - "null" - ], - "description": "State of a code scanning alert.", - "enum": [ - "open", - "dismissed", - "fixed", - null - ] - }, - "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", - "null" - ], - "description": "A classification of the file. For example to identify it as generated.", - "enum": [ - "source", - "generated", - "test", - "library", - null - ] - } - } - } - }, - "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", - "description": "A unique identifier of the repository.", "examples": [ 1296269 ] }, "node_id": { "type": "string", - "description": "The GraphQL identifier of the repository.", "examples": [ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, "name": { "type": "string", - "description": "The name of the repository.", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", - "description": "The full, globally unique, name of the repository.", "examples": [ "octocat/Hello-World" ] @@ -81247,13 +78285,11 @@ ] }, "private": { - "type": "boolean", - "description": "Whether the repository is private." + "type": "boolean" }, "html_url": { "type": "string", "format": "uri", - "description": "The URL to view the repository on GitHub.com.", "examples": [ "https://github.com/octocat/Hello-World" ] @@ -81263,287 +78299,596 @@ "string", "null" ], - "description": "The repository description.", "examples": [ "This your first repo!" ] }, "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." + "type": "boolean" }, "url": { "type": "string", "format": "uri", - "description": "The URL to get more information about the repository from the GitHub API.", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", - "description": "A template for the API URL to download the repository as an archive.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", - "description": "A template for the API URL to list the available assignees for issues in the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", - "description": "A template for the API URL to get information about branches in the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", - "description": "A template for the API URL to get information about collaborators of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", - "description": "A template for the API URL to get information about comments on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/comments{/number}" + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", - "description": "A template for the API URL to get information about commits on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", - "description": "A template for the API URL to compare two commits or refs.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", - "description": "A template for the API URL to get the contents of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", - "description": "A template for the API URL to list the contributors to the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contributors" + "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", - "description": "The API URL to list the deployments of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/deployments" + "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", - "description": "The API URL to list the downloads on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/downloads" + "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", - "description": "The API URL to list the events of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/events" + "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", - "description": "The API URL to list the forks of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/forks" + "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", - "description": "A template for the API URL to get information about Git commits of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", - "description": "A template for the API URL to get information about Git refs of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", - "description": "A template for the API URL to get information about Git tags of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, + "git_url": { + "type": "string" + }, "issue_comment_url": { "type": "string", - "description": "A template for the API URL to get information about issue comments on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", - "description": "A template for the API URL to get information about issue events on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", - "description": "A template for the API URL to get information about issues on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues{/number}" + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", - "description": "A template for the API URL to get information about deploy keys on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", - "description": "A template for the API URL to get information about labels of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/labels{/name}" + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", - "description": "The API URL to get information about the languages of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/languages" + "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", - "description": "The API URL to merge branches in the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/merges" + "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", - "description": "A template for the API URL to get information about milestones of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", - "description": "A template for the API URL to get information about notifications on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", - "description": "A template for the API URL to get information about pull requests on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", - "description": "A template for the API URL to get information about releases on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/releases{/id}" + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, + "ssh_url": { + "type": "string" + }, "stargazers_url": { "type": "string", "format": "uri", - "description": "The API URL to list the stargazers on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/stargazers" + "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", - "description": "A template for the API URL to get information about statuses of a commit.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", - "description": "The API URL to list the subscribers on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscribers" + "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", - "description": "The API URL to subscribe to notifications for this repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscription" + "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", - "description": "The API URL to get information about tags on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/tags" + "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", - "description": "The API URL to list the teams on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/teams" + "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" ] }, "hooks_url": { "type": "string", "format": "uri", - "description": "The API URL to list the hooks on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks" + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "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", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# 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", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "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": [ @@ -81594,383 +78939,16 @@ "trees_url", "url" ] - }, - "dismissal_approved_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] } - }, - "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 - }, - "classifications": [] - }, - "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances", - "repository": { + "value": { + "total_count": 1, + "repositories": [ + { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", @@ -82017,6 +78995,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}", @@ -82028,6 +79007,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", @@ -82035,90 +79015,115 @@ "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" } - } - ] + ] + } } } } - }, - "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" - } - } - } - } + "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" } }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "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": "code-scanning", - "subcategory": "code-scanning" + "category": "actions", + "subcategory": "variables" } } }, - "/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}/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": [ - "code-security" + "actions" ], - "operationId": "code-security/get-configurations-for-org", + "operationId": "actions/add-selected-repo-to-org-variable", "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/actions/variables#add-selected-repository-to-an-organization-variable" }, "parameters": [ { @@ -82131,24 +79136,110 @@ } }, { - "name": "target_type", - "in": "query", - "description": "The target type of the code security configuration", - "required": false, + "name": "name", + "description": "The name of the variable.", + "in": "path", + "required": true, "schema": { - "type": "string", - "enum": [ - "global", - "all" - ], - "default": "all" + "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", - "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 @@ -82171,364 +79262,522 @@ "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": "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", - "null" - ], - "description": "Feature options for code scanning", - "properties": { - "allow_advanced": { - "type": [ - "boolean", - "null" - ], - "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", + "properties": { + "attestations_subject_digests": { + "type": "object", + "additionalProperties": { "type": [ - "object", + "array", "null" ], - "description": "Feature options for code scanning default setup", - "properties": { - "runner_type": { - "type": [ - "string", - "null" - ], - "enum": [ - "standard", - "labeled", - "not_set", - null - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "type": [ - "string", - "null" - ], - "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": { + "items": { + "type": "object", + "properties": { + "bundle": { "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" + "mediaType": { + "type": "string" }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] + "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" } } } }, - "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" + "description": "Mapping of subject digest to bundles." + }, + "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." + }, + "previous": { + "type": "string", + "description": "The cursor to the previous page." + } }, - "updated_at": { - "type": "string", - "format": "date-time" - } + "description": "Information about the current page." } } }, "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": [ + "value": { + "attestations_subject_digests": [ + { + "sha256:abc": [ { - "security_configuration_id": 17, - "reviewer_id": 5678, - "reviewer_type": "TEAM" + "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}/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" }, - "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 + "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" }, - "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" + "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", + "content": { + "application/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/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" + } + }, + { + "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": { + "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/{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": [ + "orgs" + ], + "operationId": "orgs/delete-attestations-by-id", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/attestations#delete-attestations-by-id" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "attestation_id", + "description": "Attestation ID", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response" + }, + "204": { + "description": "Response" }, "403": { "description": "Forbidden", @@ -82586,22 +79835,51 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "code-security", - "subcategory": "configurations" + "category": "orgs", + "subcategory": "attestations" } - }, - "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.", + } + }, + "/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": [ - "code-security" + "orgs" ], - "operationId": "code-security/create-configuration", + "operationId": "orgs/list-attestations", "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/orgs#list-attestations" }, "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.", @@ -82610,624 +79888,197 @@ "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" + } } ], - "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 + "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" + } + } } } - }, - "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", - "null" - ], - "description": "Security Configuration feature options for code scanning", - "properties": { - "allow_advanced": { - "type": [ - "boolean", - "null" - ], - "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", - "null" - ], - "description": "Feature options for code scanning default setup", - "properties": { - "runner_type": { - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "type": [ - "string", - "null" - ], - "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" + } + }, + "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==" + } }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } ] } - } - } - } - } - }, - "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", - "null" - ], - "description": "Feature options for code scanning", - "properties": { - "allow_advanced": { - "type": [ - "boolean", - "null" - ], - "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", - "null" - ], - "description": "Feature options for code scanning default setup", - "properties": { - "runner_type": { - "type": [ - "string", - "null" - ], - "enum": [ - "standard", - "labeled", - "not_set", - null - ], - "description": "Whether to use labeled runners or standard GitHub runners." + }, + "repository_id": 1 }, - "runner_label": { - "type": [ - "string", - "null" - ], - "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" - ] + { + "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 } - } - }, - "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" } } } @@ -83238,22 +80089,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "code-security", - "subcategory": "configurations" + "category": "orgs", + "subcategory": "orgs" } } }, - "/orgs/{org}/code-security/configurations/defaults": { + "/orgs/{org}/blocks": { "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 users blocked by an organization", + "description": "List the users blocked by an organization.", "tags": [ - "code-security" + "orgs" ], - "operationId": "code-security/get-default-configurations", + "operationId": "orgs/list-blocked-users", "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/orgs/blocking#list-users-blocked-by-an-organization" }, "parameters": [ { @@ -83264,6 +80115,24 @@ "schema": { "type": "string" } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } } ], "responses": { @@ -83273,460 +80142,224 @@ "application/json": { "schema": { "type": "array", - "description": "A list of default code security configurations", "items": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "default_for_new_repos": { - "enum": [ - "public", - "private_and_internal", - "all" + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" ], - "description": "The visibility of newly created repositories for which the code security configuration will be applied to by default" + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] }, - "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", - "null" - ], - "description": "Feature options for code scanning", - "properties": { - "allow_advanced": { - "type": [ - "boolean", - "null" - ], - "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", - "null" - ], - "description": "Feature options for code scanning default setup", - "properties": { - "runner_type": { - "type": [ - "string", - "null" - ], - "enum": [ - "standard", - "labeled", - "not_set", - null - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "type": [ - "string", - "null" - ], - "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" - } - } + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] } }, "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" - } - }, - { - "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" - } + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "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" - }, - "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" + "category": "orgs", + "subcategory": "blocking" } } }, - "/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}/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": [ - "code-security" + "orgs" ], - "operationId": "code-security/detach-configuration", + "operationId": "orgs/check-blocked-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/code-security/configurations#detach-configurations-from-repositories" + "url": "https://docs.github.com/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization" }, "parameters": [ { @@ -83737,168 +80370,23 @@ "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": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" } } - }, + ], "responses": { "204": { - "description": "A header with no content is returned." - }, - "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", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "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" - } - } - } - } - } + "description": "If the user is blocked" }, "404": { - "description": "Resource not found", - "content": { - "application/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", + "description": "If the user is not blocked", "content": { "application/json": { "schema": { @@ -83927,22 +80415,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "code-security", - "subcategory": "configurations" + "category": "orgs", + "subcategory": "blocking" } - } - }, - "/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.", + }, + "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/get-configuration", + "operationId": "orgs/block-user", "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/orgs/blocking#block-a-user-from-an-organization" }, "parameters": [ { @@ -83955,387 +80441,88 @@ } }, { - "name": "configuration_id", - "description": "The unique identifier of the code security configuration.", + "name": "username", + "description": "The handle for the GitHub user account.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], "responses": { - "200": { - "description": "Response", + "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", - "null" - ], - "description": "Feature options for code scanning", - "properties": { - "allow_advanced": { - "type": [ - "boolean", - "null" - ], - "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", - "null" - ], - "description": "Feature options for code scanning default setup", - "properties": { - "runner_type": { - "type": [ - "string", - "null" - ], - "enum": [ - "standard", - "labeled", - "not_set", - null - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "type": [ - "string", - "null" - ], - "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": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" + { + "type": [ + "integer", + "null" ] + }, + { + "type": [ + "array", + "null" + ], + "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" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "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" } } } @@ -84346,20 +80533,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "code-security", - "subcategory": "configurations" + "category": "orgs", + "subcategory": "blocking" } }, - "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.", + "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/update-configuration", + "operationId": "orgs/unblock-user", "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/orgs/blocking#unblock-a-user-from-an-organization" }, "parameters": [ { @@ -84372,270 +80559,872 @@ } }, { - "name": "configuration_id", - "description": "The unique identifier of the code security configuration.", + "name": "username", + "description": "The handle for the GitHub user account.", "in": "path", "required": true, "schema": { - "type": "integer" + "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" - ] - }, - "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", - "null" - ], - "description": "Feature options for code scanning default setup", - "properties": { - "runner_type": { - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "type": [ - "string", - "null" - ], - "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": { + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "blocking" + } + } + }, + "/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.", + "tags": [ + "campaigns" + ], + "operationId": "campaigns/list-org-campaigns", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/campaigns/campaigns#list-campaigns-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": 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": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Campaign summary", + "description": "The campaign metadata and alert stats.", "type": "object", - "description": "Feature options for secret scanning delegated bypass", "properties": { - "reviewers": { + "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", - "description": "The bypass reviewers for secret scanning delegated bypass", "items": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], "properties": { - "reviewer_id": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" + "format": "int64", + "examples": [ + 1 + ] }, - "reviewer_type": { + "node_id": { "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "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", + "null" + ] + }, + "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", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "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", + "null" + ], + "format": "date-time" + }, + "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", + "null" + ], + "format": "uri" + }, + "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 + } + ], + "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" } - }, - "secret_scanning_validity_checks": { + } + } + } + } + }, + "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", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "minLength": 1, + "maxLength": 50 }, - "secret_scanning_non_provider_patterns": { + "description": { + "description": "A description for the campaign", "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "minLength": 1, + "maxLength": 255 }, - "secret_scanning_generic_secrets": { - "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "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" + } }, - "secret_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "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" + } }, - "private_vulnerability_reporting": { + "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 private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "date-time" }, - "enforcement": { - "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ] + "contact_link": { + "description": "The contact link of the campaign. Must be a URI.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "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": { - "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 + ] + } + ] } } } @@ -84644,373 +81433,537 @@ }, "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." + "description": "The number of the newly created campaign" }, - "target_type": { + "created_at": { "type": "string", - "description": "The type of the code security configuration.", - "enum": [ - "global", - "organization", - "enterprise" - ] + "format": "date-time", + "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." }, - "description": { + "updated_at": { "type": "string", - "description": "A description of the code security configuration" + "format": "date-time", + "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." }, - "advanced_security": { + "name": { "type": "string", - "description": "The enablement status of GitHub Advanced Security", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] + "description": "The campaign name" }, - "dependency_graph": { + "description": { "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "description": "The campaign description" }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "managers": { + "description": "The campaign managers", + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } }, - "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." - } + "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", + "null" + ] + }, + "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", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] } }, - "dependabot_alerts": { + "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 Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "date-time" }, - "dependabot_security_updates": { + "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 Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "date-time" }, - "code_scanning_options": { + "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": [ - "object", + "string", "null" ], - "description": "Feature options for code scanning", - "properties": { - "allow_advanced": { - "type": [ - "boolean", - "null" - ], - "description": "Whether to allow repos which use advanced setup" - } - } + "format": "date-time" }, - "code_scanning_default_setup": { + "state": { + "title": "Campaign state", + "description": "Indicates whether a campaign is open or closed", "type": "string", - "description": "The enablement status of code scanning default setup", "enum": [ - "enabled", - "disabled", - "not_set" + "open", + "closed" ] }, - "code_scanning_default_setup_options": { + "contact_link": { + "description": "The contact link of the campaign.", "type": [ - "object", + "string", "null" ], - "description": "Feature options for code scanning default setup", - "properties": { - "runner_type": { - "type": [ - "string", - "null" - ], - "enum": [ - "standard", - "labeled", - "not_set", - null - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "type": [ - "string", - "null" - ], - "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" - ] + "format": "uri" }, - "secret_scanning_delegated_bypass_options": { + "alert_stats": { "type": "object", - "description": "Feature options for secret scanning delegated bypass", + "additionalProperties": false, "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" - ] - } - } - } + "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" } - } - }, - "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" + }, + "required": [ + "open_count", + "closed_count", + "in_progress_count" ] - }, - "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 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": { @@ -85034,53 +81987,11 @@ } } } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": [ - "string", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -85105,8 +82016,8 @@ } } }, - "404": { - "description": "Resource not found", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -85131,25 +82042,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" } } @@ -85161,126 +82070,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/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/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization" + "url": "https://docs.github.com/rest/campaigns/campaigns#get-a-campaign-for-an-organization" }, "parameters": [ { @@ -85293,8 +82098,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": { @@ -85302,372 +82107,1248 @@ } } ], - "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", - "null" - ], - "description": "Feature options for code scanning", - "properties": { - "allow_advanced": { - "type": [ - "boolean", - "null" - ], - "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": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } }, - "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", - "null" - ], - "description": "Feature options for code scanning default setup", - "properties": { - "runner_type": { - "type": [ - "string", - "null" - ], - "enum": [ - "standard", - "labeled", - "not_set", - null - ], - "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", + "null" + ] + }, + "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": { - "type": [ - "string", - "null" - ], - "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", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] } }, - "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", + "null" + ], + "format": "date-time" + }, + "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", + "null" + ], + "format": "uri" + }, + "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/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", + "null" + ], + "format": "uri" + }, + "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": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - "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": { + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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", + "null" + ] + }, + "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", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], "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" + "examples": [ + 1 + ] }, - "reviewer_type": { + "node_id": { "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" ] } - } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] } - } + ] } }, - "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", + "null" + ], + "format": "date-time" + }, + "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", + "null" + ], + "format": "uri" + }, + "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 } } } @@ -85675,8 +83356,8 @@ } } }, - "403": { - "description": "Forbidden", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -85726,27 +83407,72 @@ } } } + }, + "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": "code-security", - "subcategory": "configurations" + "category": "campaigns", + "subcategory": "campaigns" } - } - }, - "/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.", + }, + "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/get-repositories-for-configuration", + "operationId": "campaigns/delete-campaign", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration" + "url": "https://docs.github.com/rest/campaigns/campaigns#delete-a-campaign-for-an-organization" }, "parameters": [ { @@ -85759,22 +83485,118 @@ } }, { - "name": "configuration_id", - "description": "The unique identifier of the code security configuration.", + "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": { + "application/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" + } + } + }, + "/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-scanning" + ], + "operationId": "code-scanning/list-alerts-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-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).\"", + "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", - "default": 30 + "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.", + "in": "query", + "required": false, + "schema": { + "type": [ + "string", + "null" + ], + "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." } }, { @@ -85796,13 +83618,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/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", - "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" + ] } } ], @@ -85815,57 +83708,70 @@ "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", + "null" + ], + "description": "State of a code scanning alert.", "enum": [ - "attached", - "attaching", - "detached", - "removed", - "enforced", - "failed", - "updating", - "removed_by_enterprise" + "open", + "dismissed", + "fixed", + null ] }, - "repository": { - "title": "Simple Repository", - "description": "A GitHub repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "A unique identifier of the repository.", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "description": "The GraphQL identifier of the repository.", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "description": "The name of the repository.", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "description": "The full, globally unique, name of the repository.", - "examples": [ - "octocat/Hello-World" - ] + "fixed_at": { + "type": [ + "string", + "null" + ], + "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 + }, + "dismissed_by": { + "anyOf": [ + { + "type": "null" }, - "owner": { + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -86032,98 +83938,518 @@ "type", "url" ] + } + ] + }, + "dismissed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "dismissed_reason": { + "type": [ + "string", + "null" + ], + "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", + "enum": [ + "false positive", + "won't fix", + "used in tests", + null + ] + }, + "dismissed_comment": { + "type": [ + "string", + "null" + ], + "description": "The dismissal comment associated with the dismissal of the alert.", + "maxLength": 280 + }, + "rule": { + "type": "object", + "properties": { + "id": { + "type": [ + "string", + "null" + ], + "description": "A unique identifier for the rule used to detect the alert." }, - "private": { - "type": "boolean", - "description": "Whether the repository is private." - }, - "html_url": { + "name": { "type": "string", - "format": "uri", - "description": "The URL to view the repository on GitHub.com.", - "examples": [ - "https://github.com/octocat/Hello-World" + "description": "The name of the rule used to detect the alert." + }, + "severity": { + "type": [ + "string", + "null" + ], + "description": "The severity of the alert.", + "enum": [ + "none", + "note", + "warning", + "error", + null ] }, - "description": { + "security_severity_level": { "type": [ "string", "null" ], - "description": "The repository description.", - "examples": [ - "This your first repo!" + "description": "The security severity of the alert.", + "enum": [ + "low", + "medium", + "high", + "critical", + null ] }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." + "description": { + "type": "string", + "description": "A short description of the rule used to detect the alert." }, - "url": { + "full_description": { "type": "string", - "format": "uri", - "description": "The URL to get more information about the repository from the GitHub API.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] + "description": "A description of the rule used to detect the alert." }, - "archive_url": { + "tags": { + "type": [ + "array", + "null" + ], + "description": "A set of tags applicable for the rule.", + "items": { + "type": "string" + } + }, + "help": { + "type": [ + "string", + "null" + ], + "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "type": [ + "string", + "null" + ], + "description": "A link to the documentation for the rule used to detect the alert." + } + } + }, + "tool": { + "type": "object", + "properties": { + "name": { "type": "string", - "description": "A template for the API URL to download the repository as an archive.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] + "description": "The name of the tool used to generate the code scanning analysis." }, - "assignees_url": { + "version": { + "type": [ + "string", + "null" + ], + "description": "The version of the tool used to generate the code scanning analysis." + }, + "guid": { + "type": [ + "string", + "null" + ], + "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": "A template for the API URL to list the available assignees for issues in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] + "description": "The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,\n`refs/heads/` or simply ``." }, - "blobs_url": { + "analysis_key": { "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name." }, - "branches_url": { + "environment": { "type": "string", - "description": "A template for the API URL to get information about branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] + "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." }, - "collaborators_url": { + "category": { "type": "string", - "description": "A template for the API URL to get information about collaborators of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + "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", + "null" + ], + "description": "State of a code scanning alert.", + "enum": [ + "open", + "dismissed", + "fixed", + null ] }, - "comments_url": { - "type": "string", - "description": "A template for the API URL to get information about comments on the repository.", + "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", + "null" + ], + "description": "A classification of the file. For example to identify it as generated.", + "enum": [ + "source", + "generated", + "test", + "library", + null + ] + } + } + } + }, + "repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "A unique identifier of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/comments{/number}" + 1296269 ] }, - "commits_url": { + "node_id": { "type": "string", - "description": "A template for the API URL to get information about commits on the repository.", + "description": "The GraphQL identifier of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "compare_url": { + "name": { "type": "string", - "description": "A template for the API URL to compare two commits or refs.", + "description": "The name of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "Hello-World" ] }, - "contents_url": { + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository.", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com.", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description.", + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { "type": "string", "description": "A template for the API URL to get the contents of the repository.", "examples": [ @@ -86381,421 +84707,13 @@ "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/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/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": "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", - "examples": [ - 1 - ] - }, - "name": { - "description": "Automatically generated name of this codespace.", - "type": "string", - "examples": [ - "monalisa-octocat-hello-world-g4wpq6h95q" - ] - }, - "display_name": { - "description": "Display name for this codespace.", - "type": [ - "string", - "null" - ], - "examples": [ - "bookish space pancake" - ] - }, - "environment_id": { - "description": "UUID identifying this codespace's environment.", - "type": [ - "string", - "null" - ], - "examples": [ - "26a7c758-7299-4a73-b978-5a92a7ae98a0" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + }, + "dismissal_approved_by": { + "anyOf": [ + { + "type": "null" }, - "billable_owner": { + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -86962,1241 +84880,83 @@ "type", "url" ] - }, - "repository": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "examples": [ - "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", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# 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", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "type": "object", - "title": "Codespace machine", - "description": "A description of the machine powering a codespace.", - "properties": { - "name": { - "type": "string", - "description": "The name of the machine.", - "examples": [ - "standardLinux" - ] - }, - "display_name": { - "type": "string", - "description": "The display name of the machine includes cores, memory, and storage.", - "examples": [ - "4 cores, 16 GB RAM, 64 GB storage" - ] - }, - "operating_system": { - "type": "string", - "description": "The operating system of the machine.", - "examples": [ - "linux" - ] - }, - "storage_in_bytes": { - "type": "integer", - "description": "How much storage is available to the codespace.", - "examples": [ - 68719476736 - ] - }, - "memory_in_bytes": { - "type": "integer", - "description": "How much memory is available to the codespace.", - "examples": [ - 17179869184 - ] - }, - "cpus": { - "type": "integer", - "description": "How many cores are available to the codespace.", - "examples": [ - 4 - ] - }, - "prebuild_availability": { - "type": [ - "string", - "null" - ], - "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.", - "enum": [ - "none", - "ready", - "in_progress", - null - ], - "examples": [ - "ready" - ] - } - }, - "required": [ - "name", - "display_name", - "operating_system", - "storage_in_bytes", - "memory_in_bytes", - "cpus", - "prebuild_availability" - ] - } - ] - }, - "devcontainer_path": { - "description": "Path to devcontainer.json from repo root used to create Codespace.", - "type": [ - "string", - "null" - ], - "examples": [ - ".devcontainer/example/devcontainer.json" - ] - }, - "prebuild": { - "description": "Whether the codespace was created from a prebuild.", - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "last_used_at": { - "description": "Last known time this codespace was started.", - "type": "string", - "format": "date-time", - "examples": [ - "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" - ], - "type": "string", - "examples": [ - "Available" - ] - }, - "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", - "examples": [ - 0 - ] - }, - "behind": { - "description": "The number of commits the local repository is behind the remote.", - "type": "integer", - "examples": [ - 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", - "examples": [ - "main" - ] - } - } - }, - "location": { - "description": "The initally assigned location of a new codespace.", - "enum": [ - "EastUs", - "SouthEastAsia", - "WestEurope", - "WestUs2" - ], - "type": "string", - "examples": [ - "WestUs2" - ] - }, - "idle_timeout_minutes": { - "description": "The number of minutes of inactivity after which this codespace will be automatically stopped.", - "type": [ - "integer", - "null" - ], - "examples": [ - 60 - ] - }, - "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", - "null" - ], - "format": "uri" - }, - "pulls_url": { - "description": "API URL for the Pull Request associated with this codespace, if any.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "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", - "null" - ], - "items": { - "type": "string" - } - } - } - }, - "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", - "null" - ] - }, - "pending_operation_disabled_reason": { - "description": "Text to show user when codespace is disabled by a pending operation", - "type": [ - "string", - "null" - ] - }, - "idle_timeout_notice": { - "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy", - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ], - "examples": [ - 60 - ] - }, - "retention_expires_at": { - "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T20:01:12Z" - ] - }, - "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", - "null" - ], - "examples": [ - "you've used 100% of your spending limit for Codespaces" - ] } - }, - "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" ] } - } + }, + "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": { - "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 + "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." }, - "billable_owner": { + "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=", @@ -88216,252 +84976,118 @@ "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": [] - }, - { + "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, - "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 + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "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." }, - "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": { + "path": "lib/ab12-gen.js", + "start_line": 917, + "end_line": 917, + "start_column": 7, + "end_column": 18 }, - "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": [] + "classifications": [] }, - { - "id": 1, - "name": "monalisa-octocat-hello-world-f8adfad99a", - "environment_id": "6ac8cd6d-a2d0-4ae3-8cea-e135059264df", + "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, @@ -88482,163 +85108,65 @@ "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": [] + "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" } - ] - } + } + ] } } } - } - }, - "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", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -88663,52 +85191,21 @@ } } }, - "403": { - "description": "Forbidden", + "503": { + "description": "Service unavailable", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { + "code": { "type": "string" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" } } } @@ -88718,23 +85215,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organizations" + "enabledForGitHubApps": true, + "category": "code-scanning", + "subcategory": "code-scanning" } } }, - "/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": { + "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": [ - "codespaces" + "code-security" ], - "operationId": "codespaces/set-codespaces-access", + "operationId": "code-security/get-configurations-for-org", "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#get-code-security-configurations-for-an-organization" }, "parameters": [ { @@ -88745,268 +85242,409 @@ "schema": { "type": "string" } - } - ], - "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": "Response when successfully modifying permissions." }, - "304": { - "description": "Not modified" + { + "name": "target_type", + "in": "query", + "description": "The target type of the code security configuration", + "required": false, + "schema": { + "type": "string", + "enum": [ + "global", + "all" + ], + "default": "all" + } }, - "400": { - "description": "Users are neither members nor collaborators of this organization." + { + "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, + "schema": { + "type": "integer", + "default": 30 + } }, - "404": { - "description": "Resource not found", - "content": { - "application/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": "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" } }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + { + "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" + } + } + ], + "responses": { + "200": { + "description": "Response", "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": "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", - "required": [ - "code" + "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", + "null" ], + "description": "Feature options for code scanning", "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" + "allow_advanced": { + "type": [ + "boolean", + "null" + ], + "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", + "null" + ], + "description": "Feature options for code scanning default setup", + "properties": { + "runner_type": { + "type": [ + "string", + "null" + ], + "enum": [ + "standard", + "labeled", + "not_set", + null + ], + "description": "Whether to use labeled runners or standard GitHub runners." }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" + "runner_label": { + "type": [ + "string", + "null" + ], + "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" } } } - } - } - } - }, - "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" - } - } - }, - "/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" + "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" + } ] } } } } - } - }, - "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": { @@ -89031,83 +85669,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", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "500": { - "description": "Internal Error", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -89135,23 +85698,22 @@ }, "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.", + "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/delete-codespaces-access-users", + "operationId": "code-security/create-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#create-a-code-security-configuration" }, - "deprecated": true, "parameters": [ { "name": "org", @@ -89169,27 +85731,293 @@ "application/json": { "schema": { "type": "object", + "additionalProperties": false, "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 + "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", + "null" + ], + "description": "Security Configuration feature options for code scanning", + "properties": { + "allow_advanced": { + "type": [ + "boolean", + "null" + ], + "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", + "null" + ], + "description": "Feature options for code scanning default setup", + "properties": { + "runner_type": { + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "type": [ + "string", + "null" + ], + "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": [ - "selected_usernames" + "name", + "description" ] }, "examples": { "default": { + "summary": "Example for a code security configuration", "value": { - "selected_usernames": [ - "johnDoe", - "atomIO" - ] + "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" } } } @@ -89197,136 +86025,322 @@ } }, "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", + "201": { + "description": "Successfully created code security configuration", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", + "description": "A code security configuration", "properties": { - "message": { - "type": "string" + "id": { + "type": "integer", + "description": "The ID of the code security configuration" }, - "documentation_url": { - "type": "string" + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." }, - "url": { - "type": "string" + "target_type": { + "type": "string", + "description": "The type of the code security configuration.", + "enum": [ + "global", + "organization", + "enterprise" + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" + "description": { + "type": "string", + "description": "A description of the code security configuration" }, - "documentation_url": { - "type": "string" + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] + "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", + "null" + ], + "description": "Feature options for code scanning", + "properties": { + "allow_advanced": { + "type": [ + "boolean", + "null" + ], + "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", + "null" + ], + "description": "Feature options for code scanning default setup", + "properties": { + "runner_type": { + "type": [ + "string", + "null" + ], + "enum": [ + "standard", + "labeled", + "not_set", + null + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "type": [ + "string", + "null" + ], + "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" }, - { - "type": [ - "integer", - "null" + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" ] - }, - { - "type": [ - "array", - "null" - ], - "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" + "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" + "type": "string", + "format": "uri", + "description": "The URL of the configuration" }, - "status": { - "type": "string" + "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" } } } @@ -89336,23 +86350,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organizations" + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" } } }, - "/orgs/{org}/codespaces/secrets": { + "/orgs/{org}/code-security/configurations/defaults": { "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.", + "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": [ - "codespaces" + "code-security" ], - "operationId": "codespaces/list-org-secrets", + "operationId": "code-security/get-default-configurations", "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#get-default-code-security-configurations" }, "parameters": [ { @@ -89363,24 +86377,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": { @@ -89389,95 +86385,437 @@ "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": "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" + }, "name": { - "description": "The name of the secret", "type": "string", - "examples": [ - "SECRET_NAME" + "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" ] }, - "created_at": { - "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "description": { "type": "string", - "format": "date-time" + "description": "A description of the code security configuration" }, - "updated_at": { - "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "advanced_security": { "type": "string", - "format": "date-time" + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] }, - "visibility": { - "description": "The type of repositories in the organization that the secret is visible to", + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", "enum": [ - "all", - "private", - "selected" + "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", + "null" ], - "type": "string" + "description": "Feature options for code scanning", + "properties": { + "allow_advanced": { + "type": [ + "boolean", + "null" + ], + "description": "Whether to allow repos which use advanced setup" + } + } }, - "selected_repositories_url": { - "description": "The API URL at which the list of repositories this secret is visible to can be retrieved", + "code_scanning_default_setup": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/ORGANIZATION/codespaces/secrets/SECRET_NAME/repositories" + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": [ + "object", + "null" + ], + "description": "Feature options for code scanning default setup", + "properties": { + "runner_type": { + "type": [ + "string", + "null" + ], + "enum": [ + "standard", + "labeled", + "not_set", + null + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "type": [ + "string", + "null" + ], + "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": [ - "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" - }, - { - "name": "GIST_ID", - "created_at": "2020-01-10T10:59:22Z", - "updated_at": "2020-01-11T11:59:22Z", - "visibility": "all" + "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" } - ] + }, + { + "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" + } + } + ] + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "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" + } + } } } } @@ -89485,23 +86823,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organization-secrets" + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" } } }, - "/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.", + "/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/get-org-public-key", + "operationId": "code-security/detach-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key" + "url": "https://docs.github.com/rest/code-security/configurations#detach-configurations-from-repositories" }, "parameters": [ { @@ -89514,65 +86852,184 @@ } } ], + "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 + ] + } + } + } + } + } + }, "responses": { - "200": { - "description": "Response", + "204": { + "description": "A header with no content is returned." + }, + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { - "title": "CodespacesPublicKey", - "description": "The public key used for setting Codespaces secrets.", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "key_id": { - "description": "The identifier for the key.", - "type": "string", - "examples": [ - "1234567" - ] + "message": { + "type": "string" }, - "key": { - "description": "The Base64 encoded public key.", - "type": "string", - "examples": [ - "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" - ] + "documentation_url": { + "type": "string" }, - "id": { - "type": "integer", - "examples": [ - 2 + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" ] }, - "url": { - "type": "string", - "examples": [ - "https://api.github.com/user/keys/2" + "documentation_url": { + "type": [ + "string", + "null" ] }, - "title": { - "type": "string", - "examples": [ - "ssh-rsa AAAAB3NzaC1yc2EAAA" + "detail": { + "type": [ + "string", + "null" ] }, - "created_at": { - "type": "string", - "examples": [ - "2011-01-26T19:01:12Z" + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } } - }, - "required": [ - "key_id", - "key" - ] - }, - "examples": { - "default": { - "value": { - "key_id": "012345678912345678", - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + } + } + } + } + }, + "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" } } } @@ -89582,23 +87039,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}": { + "/orgs/{org}/code-security/configurations/{configuration_id}": { "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.", + "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/get-org-secret", + "operationId": "code-security/get-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#get-a-code-security-configuration" }, "parameters": [ { @@ -89611,12 +87068,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" } } ], @@ -89626,69 +87083,374 @@ "content": { "application/json": { "schema": { - "title": "Codespaces Secret", - "description": "Secrets for a GitHub Codespace.", "type": "object", + "description": "A code security configuration", "properties": { + "id": { + "type": "integer", + "description": "The ID of the code security configuration" + }, "name": { - "description": "The name of the secret", "type": "string", - "examples": [ - "SECRET_NAME" + "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" ] }, - "created_at": { - "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "description": { "type": "string", - "format": "date-time" + "description": "A description of the code security configuration" }, - "updated_at": { - "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "advanced_security": { "type": "string", - "format": "date-time" + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] }, - "visibility": { - "description": "The type of repositories in the organization that the secret is visible to", + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", "enum": [ - "all", - "private", - "selected" + "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", + "null" ], - "type": "string" + "description": "Feature options for code scanning", + "properties": { + "allow_advanced": { + "type": [ + "boolean", + "null" + ], + "description": "Whether to allow repos which use advanced setup" + } + } }, - "selected_repositories_url": { - "description": "The API URL at which the list of repositories this secret is visible to can be retrieved", + "code_scanning_default_setup": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/ORGANIZATION/codespaces/secrets/SECRET_NAME/repositories" + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": [ + "object", + "null" + ], + "description": "Feature options for code scanning default setup", + "properties": { + "runner_type": { + "type": [ + "string", + "null" + ], + "enum": [ + "standard", + "labeled", + "not_set", + null + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "type": [ + "string", + "null" + ], + "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": [ - "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" + "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" } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", + } + }, + "304": { + "description": "Not modified" + }, + "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" + } + } } } } @@ -89696,21 +87458,21 @@ }, "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/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.", + "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/create-or-update-org-secret", + "operationId": "code-security/update-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret" + "url": "https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration" }, "parameters": [ { @@ -89723,12 +87485,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" } } ], @@ -89738,47 +87500,255 @@ "application/json": { "schema": { "type": "object", + "additionalProperties": false, "properties": { - "encrypted_value": { + "name": { "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})$" + "description": "The name of the code security configuration. Must be unique within the organization." }, - "key_id": { + "description": { "type": "string", - "description": "The ID of the key you used to encrypt the secret." + "description": "A description of the code security configuration", + "maxLength": 255 }, - "visibility": { + "advanced_security": { "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 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": [ - "all", - "private", - "selected" + "enabled", + "disabled", + "code_security", + "secret_protection" ] }, - "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" + "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", + "null" + ], + "description": "Feature options for code scanning default setup", + "properties": { + "runner_type": { + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "type": [ + "string", + "null" + ], + "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" + ] } - }, - "required": [ - "visibility" - ] + } }, "examples": { "default": { + "summary": "Example for updating a code security configuration", "value": { - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678", - "visibility": "selected", - "selected_repository_ids": [ - 1296269, - 1296280 - ] + "name": "octo-org recommended settings v2", + "secret_scanning": "disabled", + "code_scanning_default_setup": "enabled" } } } @@ -89786,27 +87756,467 @@ } }, "responses": { - "201": { - "description": "Response when creating a secret", + "200": { + "description": "Response when a configuration is updated", "content": { "application/json": { "schema": { - "title": "Empty Object", - "description": "An object without any properties.", "type": "object", - "properties": {}, - "additionalProperties": false + "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", + "null" + ], + "description": "Feature options for code scanning", + "properties": { + "allow_advanced": { + "type": [ + "boolean", + "null" + ], + "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", + "null" + ], + "description": "Feature options for code scanning default setup", + "properties": { + "runner_type": { + "type": [ + "string", + "null" + ], + "enum": [ + "standard", + "labeled", + "not_set", + null + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "type": [ + "string", + "null" + ], + "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": null + "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" + } } } } } }, "204": { - "description": "Response when updating a secret" + "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": { + "application/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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "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", @@ -89834,18 +88244,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" @@ -89853,56 +88259,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", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } @@ -89912,21 +88273,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": [ { @@ -89939,40 +88302,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 } } } @@ -89981,23 +88377,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": [ { @@ -90010,76 +88406,574 @@ } }, { - "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" } } ], + "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": "Response", + "description": "Default successfully changed.", "content": { "application/json": { "schema": { "type": "object", - "required": [ - "total_count", - "repositories" - ], "properties": { - "total_count": { - "type": "integer" + "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" + ] }, - "repositories": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] + "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", + "null" + ], + "description": "Feature options for code scanning", + "properties": { + "allow_advanced": { + "type": [ + "boolean", + "null" + ], + "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", + "null" + ], + "description": "Feature options for code scanning default setup", + "properties": { + "runner_type": { + "type": [ + "string", + "null" + ], + "enum": [ + "standard", + "labeled", + "not_set", + null + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "type": [ + "string", + "null" + ], + "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", + "description": "A unique identifier of the repository.", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository.", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] }, "name": { "type": "string", + "description": "The name of the repository.", "examples": [ "Hello-World" ] }, "full_name": { "type": "string", + "description": "The full, globally unique, name of the repository.", "examples": [ "octocat/Hello-World" ] @@ -90253,11 +89147,13 @@ ] }, "private": { - "type": "boolean" + "type": "boolean", + "description": "Whether the repository is private." }, "html_url": { "type": "string", "format": "uri", + "description": "The URL to view the repository on GitHub.com.", "examples": [ "https://github.com/octocat/Hello-World" ] @@ -90267,596 +89163,287 @@ "string", "null" ], + "description": "The repository description.", "examples": [ "This your first repo!" ] }, "fork": { - "type": "boolean" + "type": "boolean", + "description": "Whether the repository is a fork." }, "url": { "type": "string", "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API.", "examples": [ "https://api.github.com/repos/octocat/Hello-World" ] }, "archive_url": { "type": "string", + "description": "A template for the API URL to download the repository as an archive.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", + "description": "A template for the API URL to get information about branches in the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", + "description": "A template for the API URL to get information about comments on the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + "https://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", + "description": "A template for the API URL to get information about commits on the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", + "description": "A template for the API URL to compare two commits or refs.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", + "description": "A template for the API URL to get the contents of the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", + "description": "A template for the API URL to list the contributors to the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" + "https://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", + "description": "The API URL to list the deployments of the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" + "https://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", + "description": "The API URL to list the downloads on the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" + "https://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", + "description": "The API URL to list the events of the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" + "https://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", + "description": "The API URL to list the forks of the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" + "https://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, - "git_url": { - "type": "string" - }, "issue_comment_url": { "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", + "description": "A template for the API URL to get information about issue events on the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", + "description": "A template for the API URL to get information about issues on the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + "https://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", + "description": "A template for the API URL to get information about labels of the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + "https://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", + "description": "The API URL to get information about the languages of the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" + "https://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", + "description": "The API URL to merge branches in the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" + "https://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", + "description": "A template for the API URL to get information about milestones of the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", + "description": "A template for the API URL to get information about notifications on the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", + "description": "A template for the API URL to get information about releases on the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + "https://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, - "ssh_url": { - "type": "string" - }, "stargazers_url": { "type": "string", "format": "uri", + "description": "The API URL to list the stargazers on the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" + "https://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", + "description": "A template for the API URL to get information about statuses of a commit.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", + "description": "The API URL to list the subscribers on the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" + "https://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", + "description": "The API URL to subscribe to notifications for this repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" + "https://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", + "description": "The API URL to get information about tags on the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" + "https://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", + "description": "The API URL to list the teams on the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" + "https://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" + "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "hooks_url": { "type": "string", "format": "uri", + "description": "The API URL to list the hooks on the repository.", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "examples": [ - "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", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# 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", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false + "https://api.github.com/repos/octocat/Hello-World/hooks" ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "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": [ @@ -90913,87 +89500,90 @@ }, "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" + "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" + } } - ] - } + } + ] } } } } }, - "404": { - "description": "Resource not found", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -91017,80 +89607,6 @@ } } } - } - }, - "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", @@ -91117,662 +89633,480 @@ } } } - }, - "409": { - "description": "Conflict when visibility type not set to selected" } }, "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/{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.", + "/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/add-selected-repo-to-org-secret", + "operationId": "codespaces/list-in-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret" + "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 } }, { - "name": "secret_name", - "description": "The name of the secret.", - "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": "string" + "type": "integer", + "default": 1 } }, { - "name": "repository_id", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], "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.", + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", "type": "object", "required": [ - "message", - "documentation_url" + "total_count", + "codespaces" ], "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + "total_count": { + "type": "integer" }, - "errors": { + "codespaces": { "type": "array", "items": { "type": "object", - "required": [ - "code" - ], + "title": "Codespace", + "description": "A codespace.", "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] }, - "message": { - "type": "string" + "name": { + "description": "Automatically generated name of this codespace.", + "type": "string", + "examples": [ + "monalisa-octocat-hello-world-g4wpq6h95q" + ] }, - "code": { - "type": "string" + "display_name": { + "description": "Display name for this codespace.", + "type": [ + "string", + "null" + ], + "examples": [ + "bookish space pancake" + ] }, - "index": { - "type": "integer" + "environment_id": { + "description": "UUID identifying this codespace's environment.", + "type": [ + "string", + "null" + ], + "examples": [ + "26a7c758-7299-4a73-b978-5a92a7ae98a0" + ] }, - "value": { - "oneOf": [ - { + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { "type": [ "string", "null" ] }, - { + "email": { "type": [ - "integer", + "string", "null" ] }, - { + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { "type": [ - "array", + "string", "null" ], - "items": { - "type": "string" - } + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] - } - } - } - } - } - } - } - } - } - }, - "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" - }, - "value": { - "oneOf": [ - { + "billable_owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { "type": [ "string", "null" ] }, - { + "email": { "type": [ - "integer", + "string", "null" ] }, - { + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { "type": [ - "array", + "string", "null" ], - "items": { - "type": "string" - } + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] - } - } - } - } - } - } - } - } - } - }, - "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" - } - } - } - } - } - }, - "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 \"[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.", - "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": { - "anyOf": [ - { - "type": "null" + }, + "repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] }, - { + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -91939,464 +90273,1009 @@ "type", "url" ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" }, - { - "title": "Organization Simple", - "description": "A GitHub organization.", + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { "type": "object", "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] + "admin": { + "type": "boolean" }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] + "maintain": { + "type": "boolean" }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] + "push": { + "type": "boolean" }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] + "triage": { + "type": "boolean" }, - "issues_url": { + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "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", "examples": [ - "https://api.github.com/orgs/github/issues" + "contributor_covenant" ] }, - "members_url": { + "name": { "type": "string", "examples": [ - "https://api.github.com/orgs/github/members{/member}" + "Contributor Covenant" ] }, - "public_members_url": { + "url": { "type": "string", + "format": "uri", "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" + "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, - "avatar_url": { + "body": { "type": "string", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "# 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" ] }, - "description": { + "html_url": { "type": [ "string", "null" ], - "examples": [ - "A great organization" - ] + "format": "uri" } }, "required": [ - "login", "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" + "html_url", + "key", + "name" ] - } - ] - }, - "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", + }, + "license": { + "type": [ + "object", + "null" + ], "properties": { - "id": { - "type": "integer" - }, - "node_id": { + "key": { "type": "string" }, "name": { "type": "string" }, - "slug": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "privacy": { + "spdx_id": { "type": "string" }, - "notification_setting": { + "url": { "type": "string" }, - "permission": { + "node_id": { "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "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" + ] + } + } }, - "permissions": { + "code_security": { "type": "object", "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] + } }, - "url": { - "type": "string", - "format": "uri" + "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" + ] + } + } }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } }, - "members_url": { - "type": "string" + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } }, - "repositories_url": { - "type": "string", - "format": "uri" + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" ] } - ] + } } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] + } + }, + "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": { + "anyOf": [ + { + "type": "null" }, { - "title": "Enterprise Team", - "description": "Group of enterprise owners and/or members", "type": "object", + "title": "Codespace machine", + "description": "A description of the machine powering a codespace.", "properties": { - "id": { - "type": "integer", - "format": "int64" - }, "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "url": { "type": "string", - "format": "uri" + "description": "The name of the machine.", + "examples": [ + "standardLinux" + ] }, - "sync_to_organizations": { + "display_name": { "type": "string", + "description": "The display name of the machine includes cores, memory, and storage.", "examples": [ - "disabled | all" + "4 cores, 16 GB RAM, 64 GB storage" ] }, - "organization_selection_type": { + "operating_system": { "type": "string", + "description": "The operating system of the machine.", "examples": [ - "disabled | all" + "linux" ] }, - "group_id": { - "type": [ - "string", - "null" - ], + "storage_in_bytes": { + "type": "integer", + "description": "How much storage is available to the codespace.", "examples": [ - "62ab9291-fae2-468e-974b-7e45096d5021" + 68719476736 ] }, - "group_name": { - "type": [ - "string", - "null" - ], + "memory_in_bytes": { + "type": "integer", + "description": "How much memory is available to the codespace.", "examples": [ - "Justice League" + 17179869184 ] }, - "html_url": { - "type": "string", - "format": "uri", + "cpus": { + "type": "integer", + "description": "How many cores are available to the codespace.", "examples": [ - "https://github.com/enterprises/dc/teams/justice-league" + 4 ] }, - "members_url": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" + "prebuild_availability": { + "type": [ + "string", + "null" + ], + "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.", + "enum": [ + "none", + "ready", + "in_progress", + null + ], + "examples": [ + "ready" + ] } }, "required": [ - "id", - "url", - "members_url", "name", - "html_url", - "slug", - "created_at", - "updated_at" + "display_name", + "operating_system", + "storage_in_bytes", + "memory_in_bytes", + "cpus", + "prebuild_availability" ] } - ], - "type": [ - "null", - "object" ] }, - "pending_cancellation_date": { - "type": [ - "string", - "null" - ], - "format": "date", - "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": { + "devcontainer_path": { + "description": "Path to devcontainer.json from repo root used to create Codespace.", "type": [ "string", "null" ], - "format": "date-time", - "description": "Timestamp of user's last GitHub Copilot activity, in ISO 8601 format." + "examples": [ + ".devcontainer/example/devcontainer.json" + ] }, - "last_activity_editor": { + "prebuild": { + "description": "Whether the codespace was created from a prebuild.", "type": [ - "string", + "boolean", "null" ], - "description": "Last editor that was used by the user for a GitHub Copilot completion." + "examples": [ + false + ] }, "created_at": { "type": "string", "format": "date-time", - "description": "Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format." + "examples": [ + "2011-01-26T19:01:12Z" + ] }, "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." + "examples": [ + "2011-01-26T19:01:12Z" + ] }, - "plan_type": { + "last_used_at": { + "description": "Last known time this codespace was started.", "type": "string", - "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "state": { + "description": "State of this codespace.", "enum": [ - "business", - "enterprise", - "unknown" + "Unknown", + "Created", + "Queued", + "Provisioning", + "Available", + "Awaiting", + "Unavailable", + "Deleted", + "Moved", + "Shutdown", + "Archived", + "Starting", + "ShuttingDown", + "Failed", + "Exporting", + "Updating", + "Rebuilding" + ], + "type": "string", + "examples": [ + "Available" + ] + }, + "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", + "examples": [ + 0 + ] + }, + "behind": { + "description": "The number of commits the local repository is behind the remote.", + "type": "integer", + "examples": [ + 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", + "examples": [ + "main" + ] + } + } + }, + "location": { + "description": "The initally assigned location of a new codespace.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], + "type": "string", + "examples": [ + "WestUs2" + ] + }, + "idle_timeout_minutes": { + "description": "The number of minutes of inactivity after which this codespace will be automatically stopped.", + "type": [ + "integer", + "null" + ], + "examples": [ + 60 + ] + }, + "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", + "null" + ], + "format": "uri" + }, + "pulls_url": { + "description": "API URL for the Pull Request associated with this codespace, if any.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "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", + "null" + ], + "items": { + "type": "string" + } + } + } + }, + "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", + "null" + ] + }, + "pending_operation_disabled_reason": { + "description": "Text to show user when codespace is disabled by a pending operation", + "type": [ + "string", + "null" + ] + }, + "idle_timeout_notice": { + "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy", + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ], + "examples": [ + 60 + ] + }, + "retention_expires_at": { + "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T20:01:12Z" + ] + }, + "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", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" ] } }, "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" + ] } } } @@ -92404,16 +91283,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=", @@ -92433,64 +91309,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": { @@ -92598,23 +91831,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": [ { @@ -92627,95 +91860,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": { @@ -92740,14 +91941,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" @@ -92755,19 +91960,64 @@ "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } } } } } } }, - "404": { - "description": "Resource not found", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -92791,28 +92041,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": [ { @@ -92825,95 +92074,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": { @@ -92938,14 +92144,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" @@ -92953,19 +92163,64 @@ "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } } } } } } }, - "404": { - "description": "Resource not found", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -92989,31 +92244,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", @@ -93026,6 +92277,7 @@ } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { @@ -93033,11 +92285,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": [ @@ -93048,72 +92300,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": { @@ -93138,14 +92345,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" @@ -93153,19 +92364,64 @@ "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } } } } } } }, - "404": { - "description": "Resource not found", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -93189,28 +92445,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": [ { @@ -93221,196 +92476,354 @@ "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" + }, + "secrets": { + "type": "array", + "items": { + "title": "Codespaces Secret", + "description": "Secrets for a GitHub Codespace.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret", + "type": "string", + "examples": [ + "SECRET_NAME" + ] + }, + "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", + "examples": [ + "https://api.github.com/orgs/ORGANIZATION/codespaces/secrets/SECRET_NAME/repositories" + ] + } + }, + "required": [ + "name", + "created_at", + "updated_at", + "visibility" + ] + } } - }, - "required": [ - "seats_cancelled" - ] + } }, "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", + "examples": [ + "1234567" + ] }, - "documentation_url": { - "type": "string" + "key": { + "description": "The Base64 encoded public key.", + "type": "string", + "examples": [ + "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" + ] + }, + "id": { + "type": "integer", + "examples": [ + 2 + ] }, "url": { - "type": "string" + "type": "string", + "examples": [ + "https://api.github.com/user/keys/2" + ] }, - "status": { - "type": "string" + "title": { + "type": "string", + "examples": [ + "ssh-rsa AAAAB3NzaC1yc2EAAA" + ] + }, + "created_at": { + "type": "string", + "examples": [ + "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": { - "type": "string" + "name": { + "description": "The name of the secret", + "type": "string", + "examples": [ + "SECRET_NAME" + ] }, - "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", + "examples": [ + "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": [ { @@ -93423,554 +92836,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", - "null" - ], - "description": "Usage metrics for Copilot editor code completions in the IDE.", - "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", - "null" - ], - "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", - "null" - ], - "description": "Usage metrics for Copilot Chat in the IDE.", - "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", - "null" - ], - "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", - "null" - ], - "description": "Usage metrics for Copilot Chat in GitHub.com", - "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", - "null" - ], - "description": "The training date for the custom model (if applicable)." - }, - "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", - "null" - ], - "description": "Usage metrics for Copilot for pull requests.", - "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", - "null" - ], - "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": { @@ -93995,14 +92947,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" @@ -94010,19 +92966,107 @@ "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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": { @@ -94050,23 +93094,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": [ { @@ -94079,145 +93123,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 } }, { @@ -94236,1256 +93156,820 @@ "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", + "required": [ + "total_count", + "repositories" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "repositories": { + "type": "array", + "items": { + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", - "description": "Details for the vulnerable dependency.", - "readOnly": true, "properties": { - "package": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, "properties": { - "ecosystem": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true + "examples": [ + "octocat" + ] }, - "name": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } }, "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, - "manifest_path": { + "private": { + "type": "boolean" + }, + "html_url": { "type": "string", - "description": "The full path to the dependency manifest file, relative to the root of the repository.", - "readOnly": true + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] }, - "scope": { + "description": { "type": [ "string", "null" ], - "description": "The execution scope of the vulnerable dependency.", - "readOnly": true, - "enum": [ - "development", - "runtime", - null + "examples": [ + "This your first repo!" ] }, - "relationship": { - "type": [ - "string", - "null" - ], - "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, - "enum": [ - "unknown", - "direct", - "transitive", - null + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" ] - } - } - }, - "security_advisory": { - "type": "object", - "description": "Details for the GitHub Security Advisory.", - "readOnly": true, - "properties": { - "ghsa_id": { + }, + "archive_url": { "type": "string", - "description": "The unique GitHub Security Advisory ID assigned to the advisory.", - "readOnly": true + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] }, - "cve_id": { - "type": [ - "string", - "null" - ], - "description": "The unique CVE ID assigned to the advisory.", - "readOnly": true + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] }, - "summary": { + "blobs_url": { "type": "string", - "description": "A short, plain text summary of the advisory.", - "readOnly": true, - "maxLength": 1024 + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] }, - "description": { + "branches_url": { "type": "string", - "description": "A long-form Markdown-supported description of the advisory.", - "readOnly": true + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] }, - "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", - "null" - ], - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": 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 - } + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] }, - "severity": { + "comments_url": { "type": "string", - "description": "The severity of the advisory.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, - "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", - "null" - ], - "description": "The full CVSS vector string for the advisory.", - "readOnly": true - } - }, - "required": [ - "score", - "vector_string" - ], - "additionalProperties": false - }, - "cvss_severities": { - "type": [ - "object", - "null" - ], - "properties": { - "cvss_v3": { - "type": [ - "object", - "null" - ], - "properties": { - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The CVSS 3 vector string." - }, - "score": { - "type": [ - "number", - "null" - ], - "description": "The CVSS 3 score.", - "minimum": 0, - "maximum": 10, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - }, - "cvss_v4": { - "type": [ - "object", - "null" - ], - "properties": { - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The CVSS 4 vector string." - }, - "score": { - "type": [ - "number", - "null" - ], - "description": "The CVSS 4 score.", - "minimum": 0, - "maximum": 10, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - } - } - }, - "epss": { - "type": [ - "object", - "null" - ], - "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", - "null" - ], - "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": 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", - "null" - ], - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": 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", - "null" - ], - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "dismissed_reason": { - "type": [ - "string", - "null" - ], - "description": "The reason that the alert was dismissed.", - "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk", - null - ] - }, - "dismissed_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment associated with the alert's dismissal.", - "maxLength": 280 - }, - "fixed_at": { - "type": [ - "string", - "null" - ], - "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 - }, - "auto_dismissed_at": { - "type": [ - "string", - "null" - ], - "description": "The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "repository": { - "title": "Simple Repository", - "description": "A GitHub repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "A unique identifier of the repository.", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "description": "The GraphQL identifier of the repository.", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "description": "The name of the repository.", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "description": "The full, globally unique, name of the repository.", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean", - "description": "Whether the repository is private." - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL to view the repository on GitHub.com.", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The repository description.", - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL to get more information about the repository from the GitHub API.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "description": "A template for the API URL to download the repository as an archive.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "description": "A template for the API URL to list the available assignees for issues in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "description": "A template for the API URL to get information about branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "description": "A template for the API URL to get information about collaborators of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "description": "A template for the API URL to get information about comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "description": "A template for the API URL to get information about commits on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] }, "compare_url": { "type": "string", - "description": "A template for the API URL to compare two commits or refs.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", - "description": "A template for the API URL to get the contents of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", - "description": "A template for the API URL to list the contributors to the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contributors" + "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", - "description": "The API URL to list the deployments of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/deployments" + "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", - "description": "The API URL to list the downloads on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/downloads" + "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", - "description": "The API URL to list the events of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/events" + "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", - "description": "The API URL to list the forks of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/forks" + "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", - "description": "A template for the API URL to get information about Git commits of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", - "description": "A template for the API URL to get information about Git refs of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", - "description": "A template for the API URL to get information about Git tags of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, + "git_url": { + "type": "string" + }, "issue_comment_url": { "type": "string", - "description": "A template for the API URL to get information about issue comments on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", - "description": "A template for the API URL to get information about issue events on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", - "description": "A template for the API URL to get information about issues on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues{/number}" + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", - "description": "A template for the API URL to get information about deploy keys on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", - "description": "A template for the API URL to get information about labels of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/labels{/name}" + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", - "description": "The API URL to get information about the languages of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/languages" + "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", - "description": "The API URL to merge branches in the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/merges" + "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", - "description": "A template for the API URL to get information about milestones of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", - "description": "A template for the API URL to get information about notifications on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", - "description": "A template for the API URL to get information about pull requests on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", - "description": "A template for the API URL to get information about releases on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/releases{/id}" + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, + "ssh_url": { + "type": "string" + }, "stargazers_url": { "type": "string", "format": "uri", - "description": "The API URL to list the stargazers on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/stargazers" + "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", - "description": "A template for the API URL to get information about statuses of a commit.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", - "description": "The API URL to list the subscribers on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscribers" + "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", - "description": "The API URL to subscribe to notifications for this repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscription" + "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", - "description": "The API URL to get information about tags on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/tags" + "http://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", - "description": "The API URL to list the teams on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/teams" + "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" ] }, "hooks_url": { "type": "string", "format": "uri", - "description": "The API URL to list the hooks on the repository.", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks" + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "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", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# 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", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "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": [ @@ -95537,431 +94021,92 @@ "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", + "value": { + "total_count": 1, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", "owner": { - "login": "octo-org", - "id": 6811672, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", - "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", "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", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "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": true, - "html_url": "https://github.com/octo-org/hello-world", - "description": null, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", "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}" + "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" } - } - ] + ] + } } } } } }, - "304": { - "description": "Not modified" - }, - "400": { - "description": "Bad Request", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -95983,53 +94128,85 @@ } } } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": [ - "string", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { + } + } + } + }, + "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" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } } } + }, + "required": [ + "selected_repository_ids" + ] + }, + "examples": { + "default": { + "value": { + "selected_repository_ids": [ + 64780797 + ] + } } } } + } + }, + "responses": { + "204": { + "description": "Response" }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -96054,6 +94231,62 @@ } } }, + "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": { @@ -96080,13 +94313,16 @@ } } }, + "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 Simple", - "description": "Validation Error Simple", + "title": "Validation Error", + "description": "Validation Error", "type": "object", "required": [ "message", @@ -96102,7 +94338,52 @@ "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } } } } @@ -96113,23 +94394,21 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "alerts" + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" } - } - }, - "/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.", + }, + "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": [ - "dependabot" + "codespaces" ], - "operationId": "dependabot/list-org-secrets", + "operationId": "codespaces/remove-selected-repo-from-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#list-organization-secrets" + "url": "https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret" }, "parameters": [ { @@ -96142,147 +94421,151 @@ } }, { - "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": "secret_name", + "description": "The name of the secret.", + "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": "repository_id", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" } } ], "responses": { - "200": { - "description": "Response", + "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": [ - "total_count", - "secrets" + "message", + "documentation_url" ], "properties": { - "total_count": { - "type": "integer" + "message": { + "type": "string" }, - "secrets": { + "documentation_url": { + "type": "string" + }, + "errors": { "type": "array", "items": { - "title": "Dependabot Secret for an Organization", - "description": "Secrets for GitHub Dependabot for an organization.", "type": "object", + "required": [ + "code" + ], "properties": { - "name": { - "description": "The name of the secret.", - "type": "string", - "examples": [ - "SECRET_TOKEN" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" + "resource": { + "type": "string" }, - "updated_at": { - "type": "string", - "format": "date-time" + "field": { + "type": "string" }, - "visibility": { - "description": "Visibility of a secret", - "enum": [ - "all", - "private", - "selected" - ], + "message": { "type": "string" }, - "selected_repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories" + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } ] } - }, - "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" + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" } } }, - "/orgs/{org}/dependabot/secrets/public-key": { + "/orgs/{org}/copilot/billing": { "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.", + "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": [ - "dependabot" + "copilot" ], - "operationId": "dependabot/get-org-public-key", + "operationId": "copilot/get-copilot-organization-details", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key" + "url": "https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization" }, "parameters": [ { @@ -96297,327 +94580,257 @@ ], "responses": { "200": { - "description": "Response", + "description": "OK", "content": { "application/json": { "schema": { - "title": "DependabotPublicKey", - "description": "The public key used for setting Dependabot Secrets.", + "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": { - "key_id": { - "description": "The identifier for the key.", + "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", - "examples": [ - "1234567" + "description": "The organization policy for allowing or blocking suggestions matching public code (duplication detection filter).", + "enum": [ + "allow", + "block", + "unconfigured" ] }, - "key": { - "description": "The Base64 encoded public key.", + "ide_chat": { "type": "string", - "examples": [ - "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" + "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": [ - "key_id", - "key" - ] + "seat_breakdown", + "public_code_suggestions", + "seat_management_setting" + ], + "additionalProperties": true }, "examples": { "default": { "value": { - "key_id": "012345678912345678", - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + "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" } } } } } - } - }, - "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", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { - "title": "Dependabot Secret for an Organization", - "description": "Secrets for GitHub Dependabot for an organization.", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "name": { - "description": "The name of the secret.", - "type": "string", - "examples": [ - "SECRET_TOKEN" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" + "message": { + "type": "string" }, - "updated_at": { - "type": "string", - "format": "date-time" + "documentation_url": { + "type": "string" }, - "visibility": { - "description": "Visibility of a secret", - "enum": [ - "all", - "private", - "selected" - ], + "url": { "type": "string" }, - "selected_repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "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" + "status": { + "type": "string" } } } } } - } - }, - "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": { + "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": [ - "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" - } - }, - "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" + "404": { + "description": "Resource not found", + "content": { + "application/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" - } - } - ], - "responses": { - "204": { - "description": "Response" + "422": { + "description": "There is a problem with your account's associated payment method." } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" + "category": "copilot", + "subcategory": "copilot-user-management" } } }, - "/orgs/{org}/dependabot/secrets/{secret_name}/repositories": { + "/orgs/{org}/copilot/billing/seats": { "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": "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": [ - "dependabot" + "copilot" ], - "operationId": "dependabot/list-selected-repos-for-org-secret", + "operationId": "copilot/list-copilot-seats", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret" + "url": "https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization" }, "parameters": [ { @@ -96629,15 +94842,6 @@ "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).\"", @@ -96653,7 +94857,7 @@ "in": "query", "schema": { "type": "integer", - "default": 30 + "default": 50 } } ], @@ -96664,1450 +94868,24 @@ "application/json": { "schema": { "type": "object", - "required": [ - "total_count", - "repositories" - ], "properties": { - "total_count": { - "type": "integer" + "total_seats": { + "type": "integer", + "description": "Total number of Copilot seats for the organization currently being billed." }, - "repositories": { + "seats": { "type": "array", "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", + "title": "Copilot Business Seat Detail", + "description": "Information about a Copilot Business seat assignment for a user, team, or organization.", "type": "object", "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "examples": [ - "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", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# 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", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "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" - } - ] - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "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/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": [ - "dependabot" - ], - "operationId": "dependabot/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" - }, - "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/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" - } - } - }, - "required": [ - "selected_repository_ids" - ] - }, - "examples": { - "default": { - "value": { - "selected_repository_ids": [ - 64780797 - ] - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" - } - } - }, - "/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": [ - "dependabot" - ], - "operationId": "dependabot/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" - }, - "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": "dependabot", - "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/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": [ - "dependabot" - ], - "operationId": "dependabot/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" - }, - "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": "dependabot", - "subcategory": "secrets" - } - } - }, - "/orgs/{org}/docker/conflicts": { - "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.", - "tags": [ - "packages" - ], - "operationId": "packages/list-docker-migration-conflicting-packages-for-organization", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-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": { - "type": "array", - "items": { - "title": "Package", - "description": "A software package", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the package.", - "type": "integer", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the package.", - "type": "string", - "examples": [ - "super-linter" - ] - }, - "package_type": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ], - "examples": [ - "docker" - ] - }, - "url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/packages/container/super-linter" - ] - }, - "html_url": { - "type": "string", - "examples": [ - "https://github.com/orgs/github/packages/container/package/super-linter" - ] - }, - "version_count": { - "description": "The number of versions of the package.", - "type": "integer", - "examples": [ - 1 - ] - }, - "visibility": { - "type": "string", - "enum": [ - "private", - "public" - ], - "examples": [ - "private" - ] - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "repository": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] + "assignee": { + "anyOf": [ + { + "type": "null" }, - "owner": { + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -98274,758 +95052,1205 @@ "type", "url" ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { + { + "title": "Organization Simple", + "description": "A GitHub organization.", "type": "object", "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" + "login": { + "type": "string", + "examples": [ + "github" + ] }, - "push": { - "type": "boolean" + "id": { + "type": "integer", + "examples": [ + 1 + ] }, - "triage": { - "type": "boolean" + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "examples": [ - "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": { + "url": { "type": "string", + "format": "uri", "examples": [ - "contributor_covenant" + "https://api.github.com/orgs/github" ] }, - "name": { + "repos_url": { "type": "string", + "format": "uri", "examples": [ - "Contributor Covenant" + "https://api.github.com/orgs/github/repos" ] }, - "url": { + "events_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" + "https://api.github.com/orgs/github/events" ] }, - "body": { + "hooks_url": { "type": "string", "examples": [ - "# 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" + "https://api.github.com/orgs/github/hooks" ] }, - "html_url": { + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { "type": [ "string", "null" ], - "format": "uri" + "examples": [ + "A great organization" + ] } }, "required": [ + "login", "url", - "html_url", - "key", - "name" + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" ] - }, - "license": { - "type": [ - "object", - "null" - ], + } + ] + }, + "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": { - "key": { + "id": { + "type": "integer" + }, + "node_id": { "type": "string" }, "name": { "type": "string" }, - "spdx_id": { + "slug": { "type": "string" }, - "url": { + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { "type": "string" }, - "node_id": { + "notification_setting": { "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "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" - ] - } - } + "permission": { + "type": "string" }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", + "permissions": { "type": "object", "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" } - } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } + "url": { + "type": "string", + "format": "uri" }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } + "members_url": { + "type": "string" }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" ] } - } + ] } - } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] }, - "custom_properties": { + { + "title": "Enterprise Team", + "description": "Group of enterprise owners and/or members", "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": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "sync_to_organizations": { + "type": "string", + "examples": [ + "disabled | all" + ] + }, + "organization_selection_type": { + "type": "string", + "examples": [ + "disabled | all" + ] + }, + "group_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "62ab9291-fae2-468e-974b-7e45096d5021" + ] + }, + "group_name": { + "type": [ + "string", + "null" + ], + "examples": [ + "Justice League" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "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" + ] } - }, - "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" + ], + "type": [ + "null", + "object" + ] + }, + "pending_cancellation_date": { + "type": [ + "string", + "null" + ], + "format": "date", + "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", + "null" + ], + "format": "date-time", + "description": "Timestamp of user's last GitHub Copilot activity, in ISO 8601 format." + }, + "last_activity_editor": { + "type": [ + "string", + "null" + ], + "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" ] } - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" + }, + "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" }, - "required": [ - "id", - "name", - "package_type", - "visibility", - "url", - "html_url", - "version_count", - "created_at", - "updated_at" + "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": [ - { - "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" - } + "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": { @@ -99052,6 +96277,152 @@ } } }, + "404": { + "description": "Resource not found", + "content": { + "application/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": { @@ -99077,27 +96448,82 @@ } } } + }, + "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": false, - "category": "packages", - "subcategory": "packages" + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-user-management" } } }, - "/orgs/{org}/events": { + "/orgs/{org}/copilot/metrics": { "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.", + "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": [ - "activity" + "copilot" ], - "operationId": "activity/list-public-org-events", + "operationId": "copilot/copilot-metrics-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/activity/events#list-public-organization-events" + "url": "https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization" }, "parameters": [ { @@ -99110,12 +96536,21 @@ } }, { - "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": "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": "integer", - "default": 30 + "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" } }, { @@ -99126,6 +96561,15 @@ "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": { @@ -99136,3737 +96580,2644 @@ "schema": { "type": "array", "items": { - "title": "Event", - "description": "Event", + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", "type": "object", "properties": { - "id": { - "type": "string" + "date": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." }, - "type": { + "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": [ - "string", + "object", "null" - ] - }, - "actor": { - "title": "Actor", - "description": "Actor", - "type": "object", + ], + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "additionalProperties": true, "properties": { - "id": { - "type": "integer" + "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." }, - "login": { - "type": "string" + "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." + } + } + } }, - "display_login": { - "type": "string" + "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", + "null" + ], + "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", + "null" + ], + "description": "Usage metrics for Copilot Chat in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat in the IDE." }, - "gravatar_id": { - "type": [ - "string", - "null" - ] + "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", + "null" + ], + "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", + "null" + ], + "description": "Usage metrics for Copilot Chat in GitHub.com", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once." }, - "url": { - "type": "string", - "format": "uri" + "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", + "null" + ], + "description": "The training date for the custom model (if applicable)." + }, + "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", + "null" + ], + "description": "Usage metrics for Copilot for pull requests.", + "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." }, - "avatar_url": { - "type": "string", - "format": "uri" + "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", + "null" + ], + "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 + } + }, + "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 + } + ] + } + ] + } + ] }, - "required": [ - "id", - "login", - "gravatar_id", - "url", - "avatar_url" + "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 + } + ] + } + ] + } + } + ] + } + } + } + } + }, + "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": "copilot", + "subcategory": "copilot-metrics" + } + } + }, + "/orgs/{org}/dependabot/alerts": { + "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.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/list-alerts-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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": "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", + "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 + } + } + ], + "responses": { + "200": { + "description": "Response", + "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" ] }, - "repo": { + "dependency": { "type": "object", + "description": "Details for the vulnerable dependency.", + "readOnly": true, "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" + "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 }, - "url": { + "manifest_path": { "type": "string", - "format": "uri" + "description": "The full path to the dependency manifest file, relative to the root of the repository.", + "readOnly": true + }, + "scope": { + "type": [ + "string", + "null" + ], + "description": "The execution scope of the vulnerable dependency.", + "readOnly": true, + "enum": [ + "development", + "runtime", + null + ] + }, + "relationship": { + "type": [ + "string", + "null" + ], + "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, + "enum": [ + "unknown", + "direct", + "transitive", + null + ] } - }, - "required": [ - "id", - "name", - "url" - ] + } }, - "org": { - "title": "Actor", - "description": "Actor", + "security_advisory": { "type": "object", + "description": "Details for the GitHub Security Advisory.", + "readOnly": true, "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "display_login": { - "type": "string" + "ghsa_id": { + "type": "string", + "description": "The unique GitHub Security Advisory ID assigned to the advisory.", + "readOnly": true }, - "gravatar_id": { + "cve_id": { "type": [ "string", "null" + ], + "description": "The unique CVE ID assigned to the advisory.", + "readOnly": 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", + "null" + ], + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": 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" ] }, - "url": { + "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", + "null" + ], + "description": "The full CVSS vector string for the advisory.", + "readOnly": true + } + }, + "required": [ + "score", + "vector_string" + ], + "additionalProperties": false + }, + "cvss_severities": { + "type": [ + "object", + "null" + ], + "properties": { + "cvss_v3": { + "type": [ + "object", + "null" + ], + "properties": { + "vector_string": { + "type": [ + "string", + "null" + ], + "description": "The CVSS 3 vector string." + }, + "score": { + "type": [ + "number", + "null" + ], + "description": "The CVSS 3 score.", + "minimum": 0, + "maximum": 10, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + }, + "cvss_v4": { + "type": [ + "object", + "null" + ], + "properties": { + "vector_string": { + "type": [ + "string", + "null" + ], + "description": "The CVSS 4 vector string." + }, + "score": { + "type": [ + "number", + "null" + ], + "description": "The CVSS 4 score.", + "minimum": 0, + "maximum": 10, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + } + } + }, + "epss": { + "type": [ + "object", + "null" + ], + "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", - "format": "uri" + "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true }, - "avatar_url": { + "updated_at": { "type": "string", - "format": "uri" + "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", + "null" + ], + "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true } }, "required": [ - "id", - "login", - "gravatar_id", - "url", - "avatar_url" - ] + "ghsa_id", + "cve_id", + "summary", + "description", + "vulnerabilities", + "severity", + "cvss", + "cwes", + "identifiers", + "references", + "published_at", + "updated_at", + "withdrawn_at" + ], + "additionalProperties": false }, - "payload": { + "security_vulnerability": { "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, "properties": { - "action": { - "type": "string" + "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 }, - "issue": { - "title": "Issue", - "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "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", + "null" + ], + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": 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", + "null" + ], + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "dismissed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, "id": { "type": "integer", - "format": "int64" + "format": "int64", + "examples": [ + 1 + ] }, "node_id": { - "type": "string" + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] }, "url": { - "description": "URL for the issue", "type": "string", "format": "uri", "examples": [ - "https://api.github.com/repositories/42/issues/1" + "https://api.github.com/users/octocat" ] }, - "repository_url": { + "html_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] }, - "labels_url": { - "type": "string" + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] }, - "comments_url": { + "following_url": { "type": "string", - "format": "uri" + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] }, "events_url": { "type": "string", - "format": "uri" + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] }, - "html_url": { + "received_events_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "type": "integer", + "type": { + "type": "string", "examples": [ - 42 + "User" ] }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", + "site_admin": { + "type": "boolean" + }, + "starred_at": { "type": "string", "examples": [ - "open" + "\"2020-07-09T00:17:55Z\"" ] }, - "state_reason": { - "description": "The reason for the current state", + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "dismissed_reason": { + "type": [ + "string", + "null" + ], + "description": "The reason that the alert was dismissed.", + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk", + null + ] + }, + "dismissed_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment associated with the alert's dismissal.", + "maxLength": 280 + }, + "fixed_at": { + "type": [ + "string", + "null" + ], + "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 + }, + "auto_dismissed_at": { + "type": [ + "string", + "null" + ], + "description": "The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "A unique identifier of the repository.", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository.", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "description": "The name of the repository.", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository.", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { "type": [ "string", "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ], + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", "examples": [ - "not_planned" + "octocat" ] }, - "title": { - "description": "Title of the issue", + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { "type": "string", "examples": [ - "Widget creation fails in Safari on OS X 10.8" + "MDQ6VXNlcjE=" ] }, - "body": { - "description": "Contents of the issue", + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { "type": [ "string", "null" ], "examples": [ - "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?" + "41d064eb2195891e12d0413f63227ea7" ] }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" ] }, - "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", - "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", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - }, + "html_url": { + "type": "string", + "format": "uri", "examples": [ - "bug", - "registration" + "https://github.com/octocat" ] }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" ] }, - "assignees": { - "type": [ - "array", - "null" - ], - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/milestones/v1.0" - ] - }, - "labels_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDk6TWlsZXN0b25lMTAwMjYwNA==" - ] - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "examples": [ - 42 - ] - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open", - "examples": [ - "open" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string", - "examples": [ - "v1.0" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "Tracking milestone for version 1.0" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 4 - ] - }, - "closed_issues": { - "type": "integer", - "examples": [ - 8 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2013-02-12T13:22:01Z" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2012-10-09T23:39:01Z" - ] - } - }, - "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" - ] - } + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "locked": { - "type": "boolean" + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] }, - "active_lock_reason": { - "type": [ - "string", - "null" + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" ] }, - "comments": { - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" ] }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] }, - "created_at": { + "received_events_url": { "type": "string", - "format": "date-time" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] }, - "updated_at": { + "type": { "type": "string", - "format": "date-time" + "examples": [ + "User" + ] }, - "draft": { + "site_admin": { "type": "boolean" }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" ] }, - "body_html": { - "type": "string" + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com.", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description.", + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks" + ] + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + } + }, + "required": [ + "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" }, - "body_text": { - "type": "string" + "severity": "high", + "vulnerable_version_range": ">= 2.0.0, < 2.0.2", + "first_patched_version": { + "identifier": "2.0.2" + } + }, + { + "package": { + "ecosystem": "pip", + "name": "django" }, - "timeline_url": { - "type": "string", - "format": "uri" + "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" }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "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", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "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" - ] + "severity": "medium", + "vulnerable_version_range": ">= 2.9.0, < 2.9.18", + "first_patched_version": { + "identifier": "2.9.18" + } + }, + { + "package": { + "ecosystem": "pip", + "name": "ansible" }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "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", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 - ] - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "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" - ] + "severity": "medium", + "vulnerable_version_range": "< 2.8.19", + "first_patched_version": { + "identifier": "2.8.19" } }, - "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", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/issues/comments/1" - ] - }, - "body": { - "description": "Contents of the issue comment", - "type": "string", - "examples": [ - "What version of Safari were you using when you observed this bug?" - ] - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "OWNER" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "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", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 - ] - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] + { + "package": { + "ecosystem": "pip", + "name": "ansible" }, - "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" - ] + "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 }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "author_association", - "user", - "url", - "created_at", - "updated_at" - ] + "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 + } }, - "pages": { - "type": "array", - "items": { - "type": "object", - "properties": { - "page_name": { - "type": "string" - }, - "title": { - "type": "string" - }, - "summary": { - "type": [ - "string", - "null" - ] - }, - "action": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "html_url": { - "type": "string" - } - } + "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}" } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" } - }, - "required": [ - "id", - "type", - "actor", - "repo", - "payload", - "public", - "created_at" ] } - }, - "examples": { - "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" - }, - "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" - }, - "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" - }, - "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" + } + } + } + }, + "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "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" + } + } } } } @@ -102876,22 +99227,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "activity", - "subcategory": "events" + "category": "dependabot", + "subcategory": "alerts" } } }, - "/orgs/{org}/failed_invitations": { + "/orgs/{org}/dependabot/secrets": { "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 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-failed-invitations", + "operationId": "dependabot/list-org-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/members#list-failed-organization-invitations" + "url": "https://docs.github.com/rest/dependabot/secrets#list-organization-secrets" }, "parameters": [ { @@ -102928,286 +99279,90 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Organization Invitation", - "description": "Organization Invitation", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "role": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "failed_at": { - "type": [ - "string", - "null" - ] - }, - "failed_reason": { - "type": [ - "string", - "null" - ] - }, - "inviter": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { + "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.", "type": "string", "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 + "SECRET_TOKEN" ] }, - "node_id": { + "created_at": { "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "format": "date-time" }, - "avatar_url": { + "updated_at": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] + "format": "date-time" }, - "gravatar_id": { - "type": [ - "string", - "null" + "visibility": { + "description": "Visibility of a secret", + "enum": [ + "all", + "private", + "selected" ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "type": "string" }, - "received_events_url": { + "selected_repositories_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" + "https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories" ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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", - "examples": [ - "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" - ] - }, - "invitation_teams_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/organizations/16/invitations/1/teams\"" - ] - }, - "invitation_source": { - "type": "string", - "examples": [ - "\"member\"" + "name", + "created_at", + "updated_at", + "visibility" ] } - }, - "required": [ - "id", - "login", - "email", - "role", - "created_at", - "inviter", - "team_count", - "invitation_teams_url", - "node_id" - ] + } } }, "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", - "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 + "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" }, - "team_count": 2, - "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams", - "invitation_source": "member" - } - ] + { + "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" + } + ] + } } } } @@ -103220,53 +99375,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": "members" + "category": "dependabot", + "subcategory": "secrets" } } }, - "/orgs/{org}/hooks": { + "/orgs/{org}/dependabot/secrets/public-key": { "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": "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/list-webhooks", + "operationId": "dependabot/get-org-public-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/webhooks#list-organization-webhooks" + "url": "https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key" }, "parameters": [ { @@ -103277,24 +99406,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": { @@ -103303,570 +99414,35 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Org Hook", - "description": "Org Hook", - "type": "object", - "properties": { - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/hooks/1" - ] - }, - "ping_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/hooks/1/pings" - ] - }, - "deliveries_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/hooks/1/deliveries" - ] - }, - "name": { - "type": "string", - "examples": [ - "web" - ] - }, - "events": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "push", - "pull_request" - ] - }, - "active": { - "type": "boolean", - "examples": [ - true - ] - }, - "config": { - "type": "object", - "properties": { - "url": { - "type": "string", - "examples": [ - "\"http://example.com/2\"" - ] - }, - "insecure_ssl": { - "type": "string", - "examples": [ - "\"0\"" - ] - }, - "content_type": { - "type": "string", - "examples": [ - "\"form\"" - ] - }, - "secret": { - "type": "string", - "examples": [ - "\"********\"" - ] - } - } - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-09-06T20:39:23Z" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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 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-webhook", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/webhooks#create-an-organization-webhook" - }, - "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": "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.", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"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).", - "examples": [ - "\"********\"" - ] - }, - "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.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ] - }, - "username": { - "type": "string", - "examples": [ - "\"kdaigle\"" - ] - }, - "password": { - "type": "string", - "examples": [ - "\"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": { - "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", - "examples": [ - 1 - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/hooks/1" - ] - }, - "ping_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/hooks/1/pings" - ] - }, - "deliveries_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/hooks/1/deliveries" - ] - }, - "name": { - "type": "string", - "examples": [ - "web" - ] - }, - "events": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "push", - "pull_request" - ] - }, - "active": { - "type": "boolean", - "examples": [ - true - ] - }, - "config": { - "type": "object", - "properties": { - "url": { - "type": "string", - "examples": [ - "\"http://example.com/2\"" - ] - }, - "insecure_ssl": { - "type": "string", - "examples": [ - "\"0\"" - ] - }, - "content_type": { - "type": "string", - "examples": [ - "\"form\"" - ] - }, - "secret": { - "type": "string", - "examples": [ - "\"********\"" - ] - } - } - }, - "updated_at": { + "key_id": { + "description": "The identifier for the key.", "type": "string", - "format": "date-time", "examples": [ - "2011-09-06T20:39:23Z" + "1234567" ] }, - "created_at": { + "key": { + "description": "The Base64 encoded public key.", "type": "string", - "format": "date-time", "examples": [ - "2011-09-06T17:26:27Z" + "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" ] - }, - "type": { - "type": "string" } }, "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", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "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" } } } @@ -103877,22 +99453,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": [ { @@ -103905,12 +99481,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" } } ], @@ -103920,165 +99496,57 @@ "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", - "examples": [ - 1 - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/hooks/1" - ] - }, - "ping_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/hooks/1/pings" - ] - }, - "deliveries_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/hooks/1/deliveries" - ] - }, "name": { + "description": "The name of the secret.", "type": "string", "examples": [ - "web" - ] - }, - "events": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "push", - "pull_request" - ] - }, - "active": { - "type": "boolean", - "examples": [ - true + "SECRET_TOKEN" ] }, - "config": { - "type": "object", - "properties": { - "url": { - "type": "string", - "examples": [ - "\"http://example.com/2\"" - ] - }, - "insecure_ssl": { - "type": "string", - "examples": [ - "\"0\"" - ] - }, - "content_type": { - "type": "string", - "examples": [ - "\"form\"" - ] - }, - "secret": { - "type": "string", - "examples": [ - "\"********\"" - ] - } - } + "created_at": { + "type": "string", + "format": "date-time" }, "updated_at": { "type": "string", - "format": "date-time", - "examples": [ - "2011-09-06T20:39:23Z" - ] + "format": "date-time" }, - "created_at": { + "visibility": { + "description": "Visibility of a secret", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "selected_repositories_url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2011-09-06T17:26:27Z" + "https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories" ] - }, - "type": { - "type": "string" } }, "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" } } } @@ -104089,20 +99557,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": [ { @@ -104115,96 +99583,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.", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"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).", - "examples": [ - "\"********\"" - ] - }, - "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.**", - "examples": [ - "\"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", - "examples": [ - "\"web\"" - ] } - } + }, + "required": [ + "visibility" + ] }, "examples": { "default": { "value": { - "active": true, - "events": [ - "pull_request" + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "selected", + "selected_repository_ids": [ + "1296269", + "1296280" ] } } @@ -104213,268 +99646,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", - "examples": [ - 1 - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/hooks/1" - ] - }, - "ping_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/hooks/1/pings" - ] - }, - "deliveries_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/hooks/1/deliveries" - ] - }, - "name": { - "type": "string", - "examples": [ - "web" - ] - }, - "events": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "push", - "pull_request" - ] - }, - "active": { - "type": "boolean", - "examples": [ - true - ] - }, - "config": { - "type": "object", - "properties": { - "url": { - "type": "string", - "examples": [ - "\"http://example.com/2\"" - ] - }, - "insecure_ssl": { - "type": "string", - "examples": [ - "\"0\"" - ] - }, - "content_type": { - "type": "string", - "examples": [ - "\"form\"" - ] - }, - "secret": { - "type": "string", - "examples": [ - "\"********\"" - ] - } - } - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-09-06T20:39:23Z" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "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": [ { @@ -104487,165 +99698,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.", - "tags": [ - "orgs" - ], - "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.", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"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).", - "examples": [ - "\"********\"" - ] - }, - "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.**", - "examples": [ - "\"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.", + "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/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": [ { @@ -104658,160 +99743,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.", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"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).", - "examples": [ - "\"********\"" - ] - }, - "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.**", - "examples": [ - "\"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.", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"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).", - "examples": [ - "\"********\"" - ] - }, - "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.**", - "examples": [ - "\"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": { @@ -104819,12 +99752,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 } }, { @@ -104835,15 +99768,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": { @@ -104852,1007 +99776,949 @@ "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", - "examples": [ - 42 - ] - }, - "guid": { - "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", - "type": "string", - "examples": [ - "58474f00-b361-11eb-836d-0e4f3503ccbe" - ] - }, - "delivered_at": { - "description": "Time when the webhook delivery occurred.", - "type": "string", - "format": "date-time", - "examples": [ - "2021-05-12T20:33:44Z" - ] - }, - "redelivery": { - "description": "Whether the webhook delivery is a redelivery.", - "type": "boolean", - "examples": [ - false - ] - }, - "duration": { - "description": "Time spent delivering.", - "type": "number", - "examples": [ - 0.03 - ] - }, - "status": { - "description": "Describes the response returned after attempting the delivery.", - "type": "string", - "examples": [ - "failed to connect" - ] - }, - "status_code": { - "description": "Status code received when delivery was made.", - "type": "integer", - "examples": [ - 502 - ] - }, - "event": { - "description": "The event that triggered the delivery.", - "type": "string", - "examples": [ - "issues" - ] - }, - "action": { - "description": "The type of activity for the event that triggered the delivery.", - "type": [ - "string", - "null" - ], - "examples": [ - "opened" - ] - }, - "installation_id": { - "description": "The id of the GitHub App installation associated with this event.", - "type": [ - "integer", - "null" - ], - "format": "int64", - "examples": [ - 123 - ] - }, - "repository_id": { - "description": "The id of the repository associated with this event.", - "type": [ - "integer", - "null" - ], - "format": "int64", - "examples": [ - 123 - ] - }, - "throttled_at": { - "description": "Time when the webhook delivery was throttled.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2021-05-12T20:33:44Z" - ] - } - }, - "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", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "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": { - "type": "string" - }, - "field": { - "type": "string" + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] }, - "message": { - "type": "string" + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] }, - "code": { - "type": "string" + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] }, - "index": { - "type": "integer" + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] }, - "value": { - "oneOf": [ - { - "type": [ - "string", + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", "null" ] }, - { + "email": { "type": [ - "integer", + "string", "null" ] }, - { + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { "type": [ - "array", + "string", "null" ], - "items": { - "type": "string" - } + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] - } - } - } - } - } - } - } - } - } - }, - "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": "Webhook delivery", - "description": "Delivery made by a webhook.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the delivery.", - "type": "integer", - "examples": [ - 42 - ] - }, - "guid": { - "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", - "type": "string", - "examples": [ - "58474f00-b361-11eb-836d-0e4f3503ccbe" - ] - }, - "delivered_at": { - "description": "Time when the delivery was delivered.", - "type": "string", - "format": "date-time", - "examples": [ - "2021-05-12T20:33:44Z" - ] - }, - "redelivery": { - "description": "Whether the delivery is a redelivery.", - "type": "boolean", - "examples": [ - false - ] - }, - "duration": { - "description": "Time spent delivering.", - "type": "number", - "examples": [ - 0.03 - ] - }, - "status": { - "description": "Description of the status of the attempted delivery", - "type": "string", - "examples": [ - "failed to connect" - ] - }, - "status_code": { - "description": "Status code received when delivery was made.", - "type": "integer", - "examples": [ - 502 - ] - }, - "event": { - "description": "The event that triggered the delivery.", - "type": "string", - "examples": [ - "issues" - ] - }, - "action": { - "description": "The type of activity for the event that triggered the delivery.", - "type": [ - "string", - "null" - ], - "examples": [ - "opened" - ] - }, - "installation_id": { - "description": "The id of the GitHub App installation associated with this event.", - "type": [ - "integer", - "null" - ], - "examples": [ - 123 - ] - }, - "repository_id": { - "description": "The id of the repository associated with this event.", - "type": [ - "integer", - "null" - ], - "examples": [ - 123 - ] - }, - "throttled_at": { - "description": "Time when the webhook delivery was throttled.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2021-05-12T20:33:44Z" - ] - }, - "url": { - "description": "The URL target of the delivery.", - "type": "string", - "examples": [ - "https://www.example.com" - ] - }, - "request": { - "type": "object", - "properties": { - "headers": { - "description": "The request headers sent with the webhook delivery.", - "type": [ - "object", - "null" - ], - "additionalProperties": true - }, - "payload": { - "description": "The webhook payload.", - "type": [ - "object", - "null" - ], - "additionalProperties": true - } - }, - "required": [ - "headers", - "payload" - ] - }, - "response": { - "type": "object", - "properties": { - "headers": { - "description": "The response headers received when the delivery was made.", - "type": [ - "object", - "null" - ], - "additionalProperties": true - }, - "payload": { - "description": "The response payload received.", - "type": [ - "string", - "null" - ], - "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", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "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": { + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { "type": "string" }, - "field": { + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { "type": "string" }, - "message": { + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { "type": "string" }, - "code": { + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { "type": "string" }, - "index": { + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { "type": "integer" }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] + "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", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" }, - { - "type": [ - "integer", - "null" - ] + "maintain": { + "type": "boolean" }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" } + } + }, + "role_name": { + "type": "string", + "examples": [ + "admin" ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "webhooks" - } - } - }, - "/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/redeliver-webhook-delivery", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/webhooks#redeliver-a-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": { - "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", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "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": { + "temp_clone_token": { "type": "string" }, - "message": { - "type": "string" + "delete_branch_on_merge": { + "type": "boolean" }, - "code": { - "type": "string" + "subscribers_count": { + "type": "integer" }, - "index": { + "network_count": { "type": "integer" }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" ] }, - { - "type": [ - "integer", - "null" + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" ] }, - { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# 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": [ - "array", + "string", "null" ], - "items": { - "type": "string" - } + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "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" + ] } } } - } - } - } - } - }, - "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", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + }, + "examples": { + "default": { + "value": { + "total_count": 1, + "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" + } + ] } } } @@ -105863,22 +100729,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "webhooks" + "category": "dependabot", + "subcategory": "secrets" } - } - }, - "/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}": { - "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.", + }, + "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": "api-insights/get-route-stats-by-actor", + "operationId": "dependabot/set-selected-repos-for-org-secret", "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/dependabot/secrets#set-selected-repositories-for-an-organization-secret" }, "parameters": [ { @@ -105891,164 +100755,39 @@ } }, { - "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", + "name": "secret_name", + "description": "The name of the secret.", "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": { - "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", - "null" - ] - }, - "last_request_timestamp": { - "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/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" } } }, - "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" - } + "required": [ + "selected_repository_ids" + ] + }, + "examples": { + "default": { + "value": { + "selected_repository_ids": [ + 64780797 ] } } @@ -106056,24 +100795,30 @@ } } }, + "responses": { + "204": { + "description": "Response" + } + }, "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "api-insights" + "category": "dependabot", + "subcategory": "secrets" } } }, - "/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.", + "/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": "api-insights/get-subject-stats", + "operationId": "dependabot/add-selected-repo-to-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/api-insights#get-subject-stats" + "url": "https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret" }, "parameters": [ { @@ -106086,163 +100831,48 @@ } }, { - "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", + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", "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, + "name": "repository_id", + "in": "path", + "required": true, "schema": { - "type": "string" + "type": "integer" } } ], "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", - "null" - ] - }, - "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" - } - ] - } - } - } - } + "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": "orgs", - "subcategory": "api-insights" + "category": "dependabot", + "subcategory": "secrets" } - } - }, - "/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.", + }, + "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": "api-insights/get-summary-stats", + "operationId": "dependabot/remove-selected-repo-from-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/api-insights#get-summary-stats" + "url": "https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret" }, "parameters": [ { @@ -106255,76 +100885,50 @@ } }, { - "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", + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", "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, + "name": "repository_id", + "in": "path", + "required": true, "schema": { - "type": "string" + "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 - } - } - } - } - } + "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": "orgs", - "subcategory": "api-insights" + "category": "dependabot", + "subcategory": "secrets" } } }, - "/orgs/{org}/insights/api/summary-stats/users/{user_id}": { + "/orgs/{org}/docker/conflicts": { "get": { - "summary": "Get summary stats by user", - "description": "Get overall statistics of API requests within the organization for a user.", + "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-summary-stats-by-user", + "operationId": "packages/list-docker-migration-conflicting-packages-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user" + "url": "https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization" }, "parameters": [ { @@ -106335,33 +100939,6 @@ "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": { @@ -106370,562 +100947,1270 @@ "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", - "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", - "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": "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": { + "title": "Package", + "description": "A software package", "type": "object", "properties": { - "timestamp": { - "type": "string" - }, - "total_request_count": { + "id": { + "description": "Unique identifier of the package.", "type": "integer", - "format": "int64" + "examples": [ + 1 + ] }, - "rate_limited_request_count": { + "name": { + "description": "The name of the package.", + "type": "string", + "examples": [ + "super-linter" + ] + }, + "package_type": { + "type": "string", + "enum": [ + "npm", + "maven", + "rubygems", + "docker", + "nuget", + "container" + ], + "examples": [ + "docker" + ] + }, + "url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/packages/container/super-linter" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "https://github.com/orgs/github/packages/container/package/super-linter" + ] + }, + "version_count": { + "description": "The number of versions of the package.", "type": "integer", - "format": "int64" + "examples": [ + 1 + ] + }, + "visibility": { + "type": "string", + "enum": [ + "private", + "public" + ], + "examples": [ + "private" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "repository": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "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", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# 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", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "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" + ] + } + ] + }, + "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": [ { - "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 + "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" }, { - "timestamp": "2024-09-11T15:25:00Z", - "total_request_count": 55872, - "rate_limited_request_count": 23 + "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/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", + "403": { + "description": "Forbidden", "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" - } + "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": [ - { - "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", + "401": { + "description": "Requires authentication", "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" - } + "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": [ - { - "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": [ { @@ -106937,42 +102222,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).\"", @@ -106983,46 +102232,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 } } ], @@ -107032,2570 +102247,3763 @@ "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", - "null" - ], - "format": "int64" - }, - "oauth_application_id": { + "type": { "type": [ - "integer", + "string", "null" - ], - "format": "int64" + ] }, - "total_request_count": { - "type": "integer" + "actor": { + "title": "Actor", + "description": "Actor", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "display_login": { + "type": "string" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "login", + "gravatar_id", + "url", + "avatar_url" + ] }, - "rate_limited_request_count": { - "type": "integer" + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "name", + "url" + ] }, - "last_rate_limited_timestamp": { - "type": [ - "string", - "null" + "org": { + "title": "Actor", + "description": "Actor", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "display_login": { + "type": "string" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "login", + "gravatar_id", + "url", + "avatar_url" ] }, - "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", - "examples": [ - 1 - ] - }, - "account": { - "anyOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "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" - ] - } - ], - "type": [ - "null", - "object" - ] - }, - "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", - "examples": [ - "https://api.github.com/app/installations/1/access_tokens" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/installation/repositories" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/organizations/github/settings/installations/1" - ] - }, - "app_id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "client_id": { - "type": "string", - "examples": [ - "Iv1.ab1112223334445c" - ] - }, - "target_id": { - "description": "The ID of the user or organization this token is being scoped to.", - "type": "integer" - }, - "target_type": { - "type": "string", - "examples": [ - "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" - ] - } - }, - "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", - "null" - ], - "examples": [ - "config.yaml" - ] - }, - "has_multiple_single_files": { - "type": "boolean", - "examples": [ - true - ] - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "config.yml", - ".github/issue_TEMPLATE.md" - ] - }, - "app_slug": { - "type": "string", - "examples": [ - "github-actions" - ] - }, - "suspended_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "suspended_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "contact_email": { - "type": [ - "string", - "null" - ], - "examples": [ - "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" - ] - } - }, - "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", + "payload": { "type": "object", "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "examples": [ - 1 - ] - }, - "account": { - "anyOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "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" - ] - } - ], - "type": [ - "null", - "object" - ] - }, - "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", - "examples": [ - "https://api.github.com/app/installations/1/access_tokens" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/installation/repositories" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/organizations/github/settings/installations/1" - ] - }, - "app_id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "client_id": { - "type": "string", - "examples": [ - "Iv1.ab1112223334445c" - ] - }, - "target_id": { - "description": "The ID of the user or organization this token is being scoped to.", - "type": "integer" - }, - "target_type": { - "type": "string", - "examples": [ - "Organization" - ] + "action": { + "type": "string" }, - "permissions": { - "title": "App Permissions", + "issue": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "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" - ] + "id": { + "type": "integer", + "format": "int64" }, - "members": { - "type": "string", - "description": "The level of permission to grant the access token for organization teams and members.", - "enum": [ - "read", - "write" - ] + "node_id": { + "type": "string" }, - "organization_administration": { + "url": { + "description": "URL for the issue", "type": "string", - "description": "The level of permission to grant the access token to manage access to an organization.", - "enum": [ - "read", - "write" + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/1" ] }, - "organization_custom_roles": { + "repository_url": { "type": "string", - "description": "The level of permission to grant the access token for custom repository roles management.", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "organization_custom_org_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom organization roles management.", - "enum": [ - "read", - "write" - ] + "labels_url": { + "type": "string" }, - "organization_custom_properties": { + "comments_url": { "type": "string", - "description": "The level of permission to grant the access token for custom property management.", - "enum": [ - "read", - "write", - "admin" - ] + "format": "uri" }, - "organization_copilot_seat_management": { + "events_url": { "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" - ] + "format": "uri" }, - "organization_announcement_banners": { + "html_url": { "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": "uri" }, - "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" + "number": { + "description": "Number uniquely identifying the issue within its repository", + "type": "integer", + "examples": [ + 42 ] }, - "organization_hooks": { + "state": { + "description": "State of the issue; either 'open' or 'closed'", "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "enum": [ - "read", - "write" + "examples": [ + "open" ] }, - "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.", + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], "enum": [ - "read", - "write" + "completed", + "reopened", + "not_planned", + "duplicate", + null + ], + "examples": [ + "not_planned" ] }, - "organization_personal_access_token_requests": { + "title": { + "description": "Title of the issue", "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" + "examples": [ + "Widget creation fails in Safari on OS X 10.8" ] }, - "organization_plan": { - "type": "string", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "enum": [ - "read" + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ], + "examples": [ + "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?" ] }, - "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" + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } ] }, - "organization_packages": { - "type": "string", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "enum": [ - "read", - "write" + "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", + "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", + "null" + ] + }, + "color": { + "type": [ + "string", + "null" + ] + }, + "default": { + "type": "boolean" + } + } + } + ] + }, + "examples": [ + "bug", + "registration" ] }, - "organization_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization secrets.", - "enum": [ - "read", - "write" + "assignee": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } ] }, - "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" - ] + "assignees": { + "type": [ + "array", + "null" + ], + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } }, - "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" + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string", + "examples": [ + "v1.0" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] + } + }, + "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" + ] + } ] }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] + "locked": { + "type": "boolean" }, - "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" + "active_lock_reason": { + "type": [ + "string", + "null" ] }, - "followers": { - "type": "string", - "description": "The level of permission to grant the access token to manage the followers belonging to a user.", - "enum": [ - "read", - "write" - ] + "comments": { + "type": "integer" }, - "git_ssh_keys": { - "type": "string", - "description": "The level of permission to grant the access token to manage git SSH keys.", - "enum": [ - "read", - "write" + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" ] }, - "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" - ] + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - "interaction_limits": { + "created_at": { "type": "string", - "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", - "enum": [ - "read", - "write" - ] + "format": "date-time" }, - "profile": { + "updated_at": { "type": "string", - "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", - "enum": [ - "write" + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } ] }, - "starring": { + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { "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", - "null" - ], - "examples": [ - "config.yaml" - ] - }, - "has_multiple_single_files": { - "type": "boolean", - "examples": [ - true - ] - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "config.yml", - ".github/issue_TEMPLATE.md" - ] - }, - "app_slug": { - "type": "string", - "examples": [ - "github-actions" - ] - }, - "suspended_by": { - "anyOf": [ - { - "type": "null" + "format": "uri" }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], "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", "null" - ] + ], + "description": "The description of the issue type." }, - "email": { + "color": { "type": [ "string", "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null ] }, - "login": { + "created_at": { "type": "string", - "examples": [ - "octocat" - ] + "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", "type": "integer", "format": "int64", "examples": [ - 1 + 42 ] }, "node_id": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "avatar_url": { + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "https://github.com/octocat/Hello-World" ] }, - "gravatar_id": { + "description": { "type": [ "string", "null" ], "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "This your first repo!" ] }, + "fork": { + "type": "boolean" + }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "https://api.github.com/repos/octocat/Hello-World" ] }, - "html_url": { + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat" + "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, - "followers_url": { + "deployments_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, - "following_url": { + "downloads_url": { "type": "string", + "format": "uri", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, - "gists_url": { + "events_url": { "type": "string", + "format": "uri", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "http://api.github.com/repos/octocat/Hello-World/events" ] }, - "starred_url": { + "forks_url": { "type": "string", + "format": "uri", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "http://api.github.com/repos/octocat/Hello-World/forks" ] }, - "subscriptions_url": { + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "http://api.github.com/repos/octocat/Hello-World/languages" ] }, - "organizations_url": { + "merges_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "http://api.github.com/repos/octocat/Hello-World/merges" ] }, - "repos_url": { + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, - "events_url": { + "statuses_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, - "received_events_url": { + "subscribers_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, - "type": { + "subscription_url": { "type": "string", + "format": "uri", "examples": [ - "User" + "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, - "site_admin": { + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { "type": "boolean" }, - "starred_at": { + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", "examples": [ - "\"2020-07-09T00:17:55Z\"" + true ] }, - "user_view_type": { + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { "type": "string", "examples": [ - "public" + "\"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": [ - "avatar_url", + "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", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "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" ] - } - ] - }, - "suspended_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "contact_email": { - "type": [ - "string", - "null" - ], - "examples": [ - "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" - ] - } - }, - "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": { - "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.", - "enum": [ - "existing_users", - "contributors_only", - "collaborators_only" - ], - "examples": [ - "collaborators_only" - ] - }, - "origin": { - "type": "string", - "examples": [ - "repository" - ] - }, - "expires_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-08-17T04:18:39Z" - ] - } - }, - "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.", - "enum": [ - "existing_users", - "contributors_only", - "collaborators_only" - ], - "examples": [ - "collaborators_only" - ] - }, - "expiry": { - "type": "string", - "description": "The duration of the interaction restriction. Default: `one_day`.", - "enum": [ - "one_day", - "three_days", - "one_week", - "one_month", - "six_months" - ], - "examples": [ - "one_month" - ] - } - }, - "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.", - "enum": [ - "existing_users", - "contributors_only", - "collaborators_only" - ], - "examples": [ - "collaborators_only" - ] - }, - "origin": { - "type": "string", - "examples": [ - "repository" - ] - }, - "expires_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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" + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "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", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "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" + ] }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" + "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", + "type": "integer", + "format": "int64", + "examples": [ + 42 ] }, - { - "type": [ - "integer", - "null" + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/comments/1" ] }, - { - "type": [ - "array", - "null" + "body": { + "description": "Contents of the issue comment", + "type": "string", + "examples": [ + "What version of Safari were you using when you observed this bug?" + ] + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" ], - "items": { + "examples": [ + "OWNER" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "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", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "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", + "null" + ] + }, + "action": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "html_url": { "type": "string" } } - ] + } } } + }, + "public": { + "type": "boolean" + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" } - } + }, + "required": [ + "id", + "type", + "actor", + "repo", + "payload", + "public", + "created_at" + ] + } + }, + "examples": { + "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" + }, + "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" + }, + "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" + }, + "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" + } + ] } } } @@ -109605,56 +106013,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": [ { @@ -109683,38 +106057,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": { @@ -110049,17 +106391,251 @@ "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", + "examples": [ + 1 + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/hooks/1" + ] + }, + "ping_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/hooks/1/pings" + ] + }, + "deliveries_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/hooks/1/deliveries" + ] + }, + "name": { + "type": "string", + "examples": [ + "web" + ] + }, + "events": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "push", + "pull_request" + ] + }, + "active": { + "type": "boolean", + "examples": [ + true + ] + }, + "config": { + "type": "object", + "properties": { + "url": { + "type": "string", + "examples": [ + "\"http://example.com/2\"" + ] + }, + "insecure_ssl": { + "type": "string", + "examples": [ + "\"0\"" + ] + }, + "content_type": { + "type": "string", + "examples": [ + "\"form\"" + ] + }, + "secret": { + "type": "string", + "examples": [ + "\"********\"" + ] + } + } + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-09-06T20:39:23Z" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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": [ { @@ -110073,49 +106649,107 @@ } ], "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.", + "format": "uri", + "examples": [ + "https://example.com/webhook" + ] + }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"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).", + "examples": [ + "\"********\"" + ] + }, + "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.**", + "examples": [ + "\"0\"" + ] + }, + { + "type": "number" + } + ] + }, + "username": { + "type": "string", + "examples": [ + "\"kdaigle\"" + ] + }, + "password": { + "type": "string", + "examples": [ + "\"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" + } } } } @@ -110128,282 +106762,151 @@ "content": { "application/json": { "schema": { - "title": "Organization Invitation", - "description": "Organization Invitation", + "title": "Org Hook", + "description": "Org Hook", "type": "object", "properties": { "id": { "type": "integer", - "format": "int64" + "examples": [ + 1 + ] }, - "login": { - "type": [ - "string", - "null" + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/hooks/1" ] }, - "email": { - "type": [ - "string", - "null" + "ping_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/hooks/1/pings" ] }, - "role": { - "type": "string" + "deliveries_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/hooks/1/deliveries" + ] }, - "created_at": { - "type": "string" + "name": { + "type": "string", + "examples": [ + "web" + ] }, - "failed_at": { - "type": [ - "string", - "null" + "events": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "push", + "pull_request" ] }, - "failed_reason": { - "type": [ - "string", - "null" + "active": { + "type": "boolean", + "examples": [ + true ] }, - "inviter": { - "title": "Simple User", - "description": "A GitHub user.", + "config": { "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" + "url": { + "type": "string", + "examples": [ + "\"http://example.com/2\"" ] }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { + "insecure_ssl": { "type": "string", "examples": [ - "User" + "\"0\"" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { + "content_type": { "type": "string", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "\"form\"" ] }, - "user_view_type": { + "secret": { "type": "string", "examples": [ - "public" + "\"********\"" ] } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "team_count": { - "type": "integer" + } }, - "node_id": { + "updated_at": { "type": "string", + "format": "date-time", "examples": [ - "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" + "2011-09-06T20:39:23Z" ] }, - "invitation_teams_url": { + "created_at": { "type": "string", + "format": "date-time", "examples": [ - "\"https://api.github.com/organizations/16/invitations/1/teams\"" + "2011-09-06T17:26:27Z" ] }, - "invitation_source": { - "type": "string", - "examples": [ - "\"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": { @@ -110509,25 +107012,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": [ { @@ -110540,8 +107042,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": { @@ -110550,8 +107052,446 @@ } ], "responses": { - "204": { - "description": "Response" + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Org Hook", + "description": "Org Hook", + "type": "object", + "properties": { + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/hooks/1" + ] + }, + "ping_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/hooks/1/pings" + ] + }, + "deliveries_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/hooks/1/deliveries" + ] + }, + "name": { + "type": "string", + "examples": [ + "web" + ] + }, + "events": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "push", + "pull_request" + ] + }, + "active": { + "type": "boolean", + "examples": [ + true + ] + }, + "config": { + "type": "object", + "properties": { + "url": { + "type": "string", + "examples": [ + "\"http://example.com/2\"" + ] + }, + "insecure_ssl": { + "type": "string", + "examples": [ + "\"0\"" + ] + }, + "content_type": { + "type": "string", + "examples": [ + "\"form\"" + ] + }, + "secret": { + "type": "string", + "examples": [ + "\"********\"" + ] + } + } + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-09-06T20:39:23Z" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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.", + "format": "uri", + "examples": [ + "https://example.com/webhook" + ] + }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"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).", + "examples": [ + "\"********\"" + ] + }, + "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.**", + "examples": [ + "\"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", + "examples": [ + "\"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", + "examples": [ + 1 + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/hooks/1" + ] + }, + "ping_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/hooks/1/pings" + ] + }, + "deliveries_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/hooks/1/deliveries" + ] + }, + "name": { + "type": "string", + "examples": [ + "web" + ] + }, + "events": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "push", + "pull_request" + ] + }, + "active": { + "type": "boolean", + "examples": [ + true + ] + }, + "config": { + "type": "object", + "properties": { + "url": { + "type": "string", + "examples": [ + "\"http://example.com/2\"" + ] + }, + "insecure_ssl": { + "type": "string", + "examples": [ + "\"0\"" + ] + }, + "content_type": { + "type": "string", + "examples": [ + "\"form\"" + ] + }, + "secret": { + "type": "string", + "examples": [ + "\"********\"" + ] + } + } + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-09-06T20:39:23Z" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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.", @@ -110656,25 +107596,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": [ { @@ -110687,282 +107624,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", - "null" - ] - }, - "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", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] - } - ] - } - }, - "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", @@ -110995,21 +107668,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": [ { @@ -111020,6 +107693,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": { @@ -111028,120 +107710,55 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "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", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "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.", + "format": "uri", + "examples": [ + "https://example.com/webhook" + ] }, - "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`.", + "examples": [ + "\"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).", + "examples": [ + "\"********\"" + ] }, - "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.**", + "examples": [ + "\"0\"" + ] + }, + { + "type": "number" + } + ] + } + } + }, + "examples": { + "default": { + "value": { + "content_type": "json", + "insecure_ssl": "0", + "secret": "********", + "url": "https://example.com/webhook" } } } @@ -111153,19 +107770,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": [ { @@ -111176,61 +107793,70 @@ "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" + "url": { + "type": "string", + "description": "The URL to which the payloads will be delivered.", + "format": "uri", + "examples": [ + "https://example.com/webhook" + ] }, - "is_enabled": { - "description": "Whether or not the issue type is enabled at the organization level.", - "type": "boolean" + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"json\"" + ] }, - "description": { - "description": "Description of the issue type.", - "type": [ - "string", - "null" + "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).", + "examples": [ + "\"********\"" ] }, - "color": { - "description": "Color for the issue type.", - "type": [ - "string", - "null" - ], - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null + "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.**", + "examples": [ + "\"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": "********" } } } @@ -111243,89 +107869,288 @@ "content": { "application/json": { "schema": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", + "type": "object", "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": { + "url": { "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null + "description": "The URL to which the payloads will be delivered.", + "format": "uri", + "examples": [ + "https://example.com/webhook" ] }, - "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`.", + "examples": [ + "\"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).", + "examples": [ + "\"********\"" + ] }, - "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.**", + "examples": [ + "\"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" + "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.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "404": { - "description": "Resource not found", + { + "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" + } + } + ], + "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", + "examples": [ + 42 + ] + }, + "guid": { + "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", + "type": "string", + "examples": [ + "58474f00-b361-11eb-836d-0e4f3503ccbe" + ] + }, + "delivered_at": { + "description": "Time when the webhook delivery occurred.", + "type": "string", + "format": "date-time", + "examples": [ + "2021-05-12T20:33:44Z" + ] + }, + "redelivery": { + "description": "Whether the webhook delivery is a redelivery.", + "type": "boolean", + "examples": [ + false + ] + }, + "duration": { + "description": "Time spent delivering.", + "type": "number", + "examples": [ + 0.03 + ] + }, + "status": { + "description": "Describes the response returned after attempting the delivery.", + "type": "string", + "examples": [ + "failed to connect" + ] + }, + "status_code": { + "description": "Status code received when delivery was made.", + "type": "integer", + "examples": [ + 502 + ] + }, + "event": { + "description": "The event that triggered the delivery.", + "type": "string", + "examples": [ + "issues" + ] + }, + "action": { + "description": "The type of activity for the event that triggered the delivery.", + "type": [ + "string", + "null" + ], + "examples": [ + "opened" + ] + }, + "installation_id": { + "description": "The id of the GitHub App installation associated with this event.", + "type": [ + "integer", + "null" + ], + "format": "int64", + "examples": [ + 123 + ] + }, + "repository_id": { + "description": "The id of the repository associated with this event.", + "type": [ + "integer", + "null" + ], + "format": "int64", + "examples": [ + 123 + ] + }, + "throttled_at": { + "description": "Time when the webhook delivery was throttled.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2021-05-12T20:33:44Z" + ] + } + }, + "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": { @@ -111347,6 +108172,48 @@ } } } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } } } }, @@ -111355,8 +108222,8 @@ "content": { "application/json": { "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", + "title": "Validation Error", + "description": "Validation Error", "type": "object", "required": [ "message", @@ -111372,7 +108239,52 @@ "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } } } } @@ -111385,21 +108297,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/{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/update-issue-type", + "operationId": "orgs/get-webhook-delivery", "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#get-a-webhook-delivery-for-an-organization-webhook" }, "parameters": [ { @@ -111412,163 +108324,258 @@ } }, { - "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" } - } - ], - "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", - "null" - ] - }, - "color": { - "description": "Color for the issue type.", - "type": [ - "string", - "null" - ], - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - } - }, - "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" - } - } - } + }, + { + "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.", - "type": [ - "object", - "null" - ], + "title": "Webhook delivery", + "description": "Delivery made by a webhook.", + "type": "object", "properties": { "id": { + "description": "Unique identifier of the delivery.", "type": "integer", - "description": "The unique identifier of the issue type." + "examples": [ + 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." + "examples": [ + "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", + "examples": [ + "2021-05-12T20:33:44Z" + ] }, - "description": { + "redelivery": { + "description": "Whether the delivery is a redelivery.", + "type": "boolean", + "examples": [ + false + ] + }, + "duration": { + "description": "Time spent delivering.", + "type": "number", + "examples": [ + 0.03 + ] + }, + "status": { + "description": "Description of the status of the attempted delivery", + "type": "string", + "examples": [ + "failed to connect" + ] + }, + "status_code": { + "description": "Status code received when delivery was made.", + "type": "integer", + "examples": [ + 502 + ] + }, + "event": { + "description": "The event that triggered the delivery.", + "type": "string", + "examples": [ + "issues" + ] + }, + "action": { + "description": "The type of activity for the event that triggered the delivery.", "type": [ "string", "null" ], - "description": "The description of the issue type." + "examples": [ + "opened" + ] }, - "color": { + "installation_id": { + "description": "The id of the GitHub App installation associated with this event.", + "type": [ + "integer", + "null" + ], + "examples": [ + 123 + ] + }, + "repository_id": { + "description": "The id of the repository associated with this event.", + "type": [ + "integer", + "null" + ], + "examples": [ + 123 + ] + }, + "throttled_at": { + "description": "Time when the webhook delivery was throttled.", "type": [ "string", "null" ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null + "format": "date-time", + "examples": [ + "2021-05-12T20:33:44Z" ] }, - "created_at": { + "url": { + "description": "The URL target of the delivery.", "type": "string", - "description": "The time the issue type created.", - "format": "date-time" + "examples": [ + "https://www.example.com" + ] }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" + "request": { + "type": "object", + "properties": { + "headers": { + "description": "The request headers sent with the webhook delivery.", + "type": [ + "object", + "null" + ], + "additionalProperties": true + }, + "payload": { + "description": "The webhook payload.", + "type": [ + "object", + "null" + ], + "additionalProperties": true + } + }, + "required": [ + "headers", + "payload" + ] }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." + "response": { + "type": "object", + "properties": { + "headers": { + "description": "The response headers received when the delivery was made.", + "type": [ + "object", + "null" + ], + "additionalProperties": true + }, + "payload": { + "description": "The response payload received.", + "type": [ + "string", + "null" + ], + "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": { @@ -111590,6 +108597,48 @@ } } } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } } } }, @@ -111598,8 +108647,8 @@ "content": { "application/json": { "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", + "title": "Validation Error", + "description": "Validation Error", "type": "object", "required": [ "message", @@ -111615,11 +108664,56 @@ "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } } } } @@ -111628,19 +108722,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": [ { @@ -111653,8 +108749,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": { @@ -111663,16 +108767,96 @@ } ], "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "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", @@ -111688,13 +108872,103 @@ "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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", @@ -111727,21 +109001,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": [ { @@ -111754,69 +109028,234 @@ } }, { - "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", + "null" + ] + }, + "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 } }, { @@ -111834,31 +109273,429 @@ } }, { - "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", + "null" + ] + }, + "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" } } ], @@ -111868,499 +109705,588 @@ "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", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/issues/1" - ] + { + "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", + { + "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", - "examples": [ - 42 - ] + "format": "int64" }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] + "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 }, - "state_reason": { - "description": "The reason for the current state", + { + "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" + }, + "actor_name": { + "type": "string" + }, + "actor_id": { + "type": "integer", + "format": "int64" + }, + "integration_id": { "type": [ - "string", + "integer", "null" ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ], - "examples": [ - "not_planned" - ] - }, - "title": { - "description": "Title of the issue", - "type": "string", - "examples": [ - "Widget creation fails in Safari on OS X 10.8" - ] + "format": "int64" }, - "body": { - "description": "Contents of the issue", + "oauth_application_id": { "type": [ - "string", + "integer", "null" ], - "examples": [ - "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?" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] + "format": "int64" }, - "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", - "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", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - }, - "examples": [ - "bug", - "registration" - ] + "total_request_count": { + "type": "integer" }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] + "rate_limited_request_count": { + "type": "integer" }, - "assignees": { + "last_rate_limited_timestamp": { "type": [ - "array", + "string", "null" - ], - "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", + "examples": [ + 1 + ] + }, + "account": { + "anyOf": [ + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -112527,2124 +110453,2653 @@ "type", "url" ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/milestones/v1.0" - ] - }, - "labels_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDk6TWlsZXN0b25lMTAwMjYwNA==" - ] - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "examples": [ - 42 - ] - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open", - "examples": [ - "open" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string", - "examples": [ - "v1.0" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "Tracking milestone for version 1.0" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 4 - ] - }, - "closed_issues": { - "type": "integer", - "examples": [ - 8 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2013-02-12T13:22:01Z" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2012-10-09T23:39:01Z" - ] - } - }, - "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" - ] - } - ] - }, - "locked": { - "type": "boolean" - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ], + "type": [ + "null", + "object" + ] + }, + "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", + "examples": [ + "https://api.github.com/app/installations/1/access_tokens" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/installation/repositories" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/organizations/github/settings/installations/1" + ] + }, + "app_id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, + "target_id": { + "description": "The ID of the user or organization this token is being scoped to.", + "type": "integer" + }, + "target_type": { + "type": "string", + "examples": [ + "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" + ] }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] + "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" + ] + } }, - "body_html": { + "example": { + "contents": "read", + "issues": "read", + "deployments": "write", + "single_file": "read" + } + }, + "events": { + "type": "array", + "items": { "type": "string" - }, - "body_text": { + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "single_file_name": { + "type": [ + "string", + "null" + ], + "examples": [ + "config.yaml" + ] + }, + "has_multiple_single_files": { + "type": "boolean", + "examples": [ + true + ] + }, + "single_file_paths": { + "type": "array", + "items": { "type": "string" }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "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", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "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." - } + "examples": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ] + }, + "app_slug": { + "type": "string", + "examples": [ + "github-actions" + ] + }, + "suspended_by": { + "anyOf": [ + { + "type": "null" }, - "required": [ - "id", - "node_id", - "name", - "description" - ] + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "contact_email": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" + ] + } + }, + "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": { - "title": "Repository", - "description": "A repository on GitHub.", + "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": { "id": { - "description": "Unique identifier of the repository", + "description": "The ID of the installation.", "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", "examples": [ - "octocat/Hello-World" + 1 ] }, - "license": { + "account": { "anyOf": [ { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "key": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { "type": "string", "examples": [ - "mit" + "octocat" ] }, - "name": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { "type": "string", "examples": [ - "MIT License" + "MDQ6VXNlcjE=" ] }, - "url": { + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { "type": [ "string", "null" ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", "format": "uri", "examples": [ - "https://api.github.com/licenses/mit" + "https://api.github.com/users/octocat" ] }, - "spdx_id": { + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", "type": [ "string", "null" ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", "examples": [ - "MIT" + 42 ] }, "node_id": { "type": "string", "examples": [ - "MDc6TGljZW5zZW1pdA==" + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "html_url": { + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { "type": "string", "format": "uri" } }, "required": [ - "key", + "id", + "node_id", "name", - "url", - "spdx_id", - "node_id" + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" ] } + ], + "type": [ + "null", + "object" ] }, - "forks": { + "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", + "examples": [ + "https://api.github.com/app/installations/1/access_tokens" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/installation/repositories" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/organizations/github/settings/installations/1" + ] + }, + "app_id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "Iv1.ab1112223334445c" + ] + }, + "target_id": { + "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" }, + "target_type": { + "type": "string", + "examples": [ + "Organization" + ] + }, "permissions": { + "title": "App Permissions", "type": "object", + "description": "The permissions granted to the user access token.", "properties": { - "admin": { - "type": "boolean" + "actions": { + "type": "string", + "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", + "enum": [ + "read", + "write" + ] }, - "pull": { - "type": "boolean" + "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" + ] }, - "triage": { - "type": "boolean" + "checks": { + "type": "string", + "description": "The level of permission to grant the access token for checks on code.", + "enum": [ + "read", + "write" + ] }, - "push": { - "type": "boolean" + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" + "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" ] }, - "email": { - "type": [ - "string", - "null" + "dependabot_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" ] }, - "login": { + "deployments": { "type": "string", - "examples": [ - "octocat" + "description": "The level of permission to grant the access token for deployments and deployment statuses.", + "enum": [ + "read", + "write" ] }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 + "environments": { + "type": "string", + "description": "The level of permission to grant the access token for managing repository environments.", + "enum": [ + "read", + "write" ] }, - "node_id": { + "issues": { "type": "string", - "examples": [ - "MDQ6VXNlcjE=" + "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", + "enum": [ + "read", + "write" ] }, - "avatar_url": { + "metadata": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", + "enum": [ + "read", + "write" ] }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "packages": { + "type": "string", + "description": "The level of permission to grant the access token for packages published to GitHub Packages.", + "enum": [ + "read", + "write" ] }, - "url": { + "pages": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" + "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" ] }, - "html_url": { + "pull_requests": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" + "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", + "enum": [ + "read", + "write" ] }, - "followers_url": { + "repository_custom_properties": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" + "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" ] }, - "following_url": { + "repository_hooks": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", + "enum": [ + "read", + "write" ] }, - "gists_url": { + "repository_projects": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", + "enum": [ + "read", + "write", + "admin" ] }, - "starred_url": { + "secret_scanning_alerts": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", + "enum": [ + "read", + "write" ] }, - "subscriptions_url": { + "secrets": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "description": "The level of permission to grant the access token to manage repository secrets.", + "enum": [ + "read", + "write" ] }, - "organizations_url": { + "security_events": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" + "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", + "enum": [ + "read", + "write" ] }, - "repos_url": { + "single_file": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" + "description": "The level of permission to grant the access token to manage just a single file.", + "enum": [ + "read", + "write" ] }, - "events_url": { + "statuses": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "description": "The level of permission to grant the access token for commit statuses.", + "enum": [ + "read", + "write" ] }, - "received_events_url": { + "vulnerability_alerts": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" + "description": "The level of permission to grant the access token to manage Dependabot alerts.", + "enum": [ + "read", + "write" ] }, - "type": { + "workflows": { "type": "string", - "examples": [ - "User" + "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", + "enum": [ + "write" ] }, - "site_admin": { - "type": "boolean" + "members": { + "type": "string", + "description": "The level of permission to grant the access token for organization teams and members.", + "enum": [ + "read", + "write" + ] }, - "starred_at": { + "organization_administration": { "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" + "description": "The level of permission to grant the access token to manage access to an organization.", + "enum": [ + "read", + "write" ] }, - "user_view_type": { + "organization_custom_roles": { "type": "string", - "examples": [ - "public" + "description": "The level of permission to grant the access token for custom repository roles management.", + "enum": [ + "read", + "write" ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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" + }, + "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" + } }, - "html_url": { + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "created_at": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] + "format": "date-time" }, - "description": { + "updated_at": { + "type": "string", + "format": "date-time" + }, + "single_file_name": { "type": [ "string", "null" ], "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + "config.yaml" ] }, - "branches_url": { - "type": "string", + "has_multiple_single_files": { + "type": "boolean", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + true ] }, - "collaborators_url": { - "type": "string", + "single_file_paths": { + "type": "array", + "items": { + "type": "string" + }, "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + "config.yml", + ".github/issue_TEMPLATE.md" ] }, - "comments_url": { + "app_slug": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + "github-actions" ] }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "suspended_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } ] }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - "contents_url": { - "type": "string", + "contact_email": { + "type": [ + "string", + "null" + ], "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" ] + } + }, + "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": { + "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 }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] + "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" }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] + "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.", + "enum": [ + "existing_users", + "contributors_only", + "collaborators_only" + ], + "examples": [ + "collaborators_only" + ] + }, + "origin": { + "type": "string", + "examples": [ + "repository" + ] + }, + "expires_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-08-17T04:18:39Z" + ] + } + }, + "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.", + "enum": [ + "existing_users", + "contributors_only", + "collaborators_only" + ], + "examples": [ + "collaborators_only" + ] + }, + "expiry": { + "type": "string", + "description": "The duration of the interaction restriction. Default: `one_day`.", + "enum": [ + "one_day", + "three_days", + "one_week", + "one_month", + "six_months" + ], + "examples": [ + "one_month" + ] + } + }, + "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.", + "enum": [ + "existing_users", + "contributors_only", + "collaborators_only" + ], + "examples": [ + "collaborators_only" + ] + }, + "origin": { + "type": "string", + "examples": [ + "repository" + ] + }, + "expires_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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" }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] + "field": { + "type": "string" }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] + "message": { + "type": "string" }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] + "code": { + "type": "string" }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] + "index": { + "type": "integer" }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + } + } + } + } + } + } + } + } + } + }, + "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", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "role": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "failed_at": { + "type": [ + "string", + "null" + ] + }, + "failed_reason": { + "type": [ + "string", + "null" + ] + }, + "inviter": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" ] }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" + "email": { + "type": [ + "string", + "null" ] }, - "issue_comment_url": { + "login": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + "octocat" ] }, - "issue_events_url": { - "type": "string", + "id": { + "type": "integer", + "format": "int64", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + 1 ] }, - "issues_url": { + "node_id": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + "MDQ6VXNlcjE=" ] }, - "keys_url": { + "avatar_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + "https://github.com/images/error/octocat_happy.gif" ] }, - "labels_url": { - "type": "string", + "gravatar_id": { + "type": [ + "string", + "null" + ], "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + "41d064eb2195891e12d0413f63227ea7" ] }, - "languages_url": { + "url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" + "https://api.github.com/users/octocat" ] }, - "merges_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" + "https://github.com/octocat" ] }, - "stargazers_url": { + "followers_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" + "https://api.github.com/users/octocat/followers" ] }, - "statuses_url": { + "following_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "subscribers_url": { + "gists_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "subscription_url": { + "starred_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "tags_url": { + "subscriptions_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" + "https://api.github.com/users/octocat/subscriptions" ] }, - "teams_url": { + "organizations_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + "https://api.github.com/users/octocat/orgs" ] }, - "clone_url": { + "repos_url": { "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], "format": "uri", "examples": [ - "git:git.example.com/octocat/Hello-World" + "https://api.github.com/users/octocat/repos" ] }, - "hooks_url": { + "events_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "svn_url": { + "received_events_url": { "type": "string", "format": "uri", "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 + "https://api.github.com/users/octocat/received_events" ] }, - "default_branch": { - "description": "The default branch of the repository.", + "type": { "type": "string", "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true + "User" ] }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, + "site_admin": { "type": "boolean" }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "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": { + "starred_at": { "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", "examples": [ - true + "\"2020-07-09T00:17:55Z\"" ] }, - "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": { + "user_view_type": { "type": "string", "examples": [ - "\"2020-07-09T00:17:42Z\"" + "public" ] - }, - "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", + "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", - "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" + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "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", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 - ] - } - }, - "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", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], "examples": [ - "OWNER" + "\"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", + "examples": [ + "\"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", + "examples": [ + "\"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" ] } }, @@ -114653,263 +113108,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" } ] } @@ -114954,23 +113182,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": [ { @@ -114981,267 +113207,340 @@ "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": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "title": "Organization Invitation", + "description": "Organization Invitation", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "role": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "failed_at": { + "type": [ + "string", + "null" + ] + }, + "failed_reason": { + "type": [ + "string", + "null" + ] + }, + "inviter": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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", + "examples": [ + "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" + ] + }, + "invitation_teams_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/organizations/16/invitations/1/teams\"" + ] + }, + "invitation_source": { + "type": "string", + "examples": [ + "\"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" + } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } } }, "422": { @@ -115318,9 +113617,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", @@ -115328,17 +113654,17 @@ } } }, - "/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.", + "/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/check-membership-for-user", + "operationId": "orgs/cancel-invitation", "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#cancel-an-organization-invitation" }, "parameters": [ { @@ -115351,78 +113677,96 @@ } }, { - "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" } } ], "responses": { "204": { - "description": "Response if requester is an organization member and user is a member" + "description": "Response" }, - "302": { - "description": "Response if requester is not an organization member", - "headers": { - "Location": { - "example": "https://api.github.com/orgs/github/public_members/pezra", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { "schema": { - "type": "string" + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } } } } }, "404": { - "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", + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -115449,6 +113793,7 @@ } }, "x-github": { + "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", @@ -115456,19 +113801,37 @@ } } }, - "/orgs/{org}/members/{username}/codespaces": { + "/orgs/{org}/invitations/{invitation_id}/teams": { "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.", + "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": [ - "codespaces" + "orgs" ], - "operationId": "codespaces/get-codespaces-for-user-in-org", + "operationId": "orgs/list-invitation-teams", "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/members#list-organization-invitation-teams" }, "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" + } + }, { "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).\"", @@ -115486,24 +113849,6 @@ "type": "integer", "default": 1 } - }, - { - "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": { @@ -115512,82 +113857,97 @@ "content": { "application/json": { "schema": { - "type": "object", - "required": [ - "total_count", - "codespaces" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "codespaces": { - "type": "array", - "items": { + "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", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { "type": "object", - "title": "Codespace", - "description": "A codespace.", "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] + "pull": { + "type": "boolean" }, - "name": { - "description": "Automatically generated name of this codespace.", - "type": "string", - "examples": [ - "monalisa-octocat-hello-world-g4wpq6h95q" - ] + "triage": { + "type": "boolean" }, - "display_name": { - "description": "Display name for this codespace.", - "type": [ - "string", - "null" - ], - "examples": [ - "bookish space pancake" - ] + "push": { + "type": "boolean" }, - "environment_id": { - "description": "UUID identifying this codespace's environment.", - "type": [ - "string", - "null" - ], - "examples": [ - "26a7c758-7299-4a73-b978-5a92a7ae98a0" - ] + "maintain": { + "type": "boolean" }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { + "description": "Unique identifier of the team", "type": "integer", - "format": "int64", "examples": [ 1 ] @@ -115595,1959 +113955,154 @@ "node_id": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "MDQ6VGVhbTE=" ] }, "url": { + "description": "URL for the team", "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" + "https://api.github.com/organizations/1/team/1" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { + "members_url": { "type": "string", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "https://api.github.com/organizations/1/team/1/members{/member}" ] }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "billable_owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { + "description": "Name of the team", "type": "string", - "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "Justice League" ] }, - "gravatar_id": { + "description": { + "description": "Description of the team", "type": [ "string", "null" ], "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "A great team." ] }, - "starred_url": { + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "admin" ] }, - "subscriptions_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "closed" ] }, - "organizations_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "notifications_enabled" ] }, - "repos_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "https://github.com/orgs/rails/teams/core" ] }, - "received_events_url": { + "repositories_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" + "https://api.github.com/organizations/1/team/1/repos" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { + "slug": { "type": "string", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "justice-league" ] }, - "user_view_type": { + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ - "public" + "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "examples": [ - "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", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# 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", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "type": "object", - "title": "Codespace machine", - "description": "A description of the machine powering a codespace.", - "properties": { - "name": { - "type": "string", - "description": "The name of the machine.", - "examples": [ - "standardLinux" - ] - }, - "display_name": { - "type": "string", - "description": "The display name of the machine includes cores, memory, and storage.", - "examples": [ - "4 cores, 16 GB RAM, 64 GB storage" - ] - }, - "operating_system": { - "type": "string", - "description": "The operating system of the machine.", - "examples": [ - "linux" - ] - }, - "storage_in_bytes": { - "type": "integer", - "description": "How much storage is available to the codespace.", - "examples": [ - 68719476736 - ] - }, - "memory_in_bytes": { - "type": "integer", - "description": "How much memory is available to the codespace.", - "examples": [ - 17179869184 - ] - }, - "cpus": { - "type": "integer", - "description": "How many cores are available to the codespace.", - "examples": [ - 4 - ] - }, - "prebuild_availability": { - "type": [ - "string", - "null" - ], - "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.", - "enum": [ - "none", - "ready", - "in_progress", - null - ], - "examples": [ - "ready" - ] - } - }, - "required": [ - "name", - "display_name", - "operating_system", - "storage_in_bytes", - "memory_in_bytes", - "cpus", - "prebuild_availability" - ] - } - ] - }, - "devcontainer_path": { - "description": "Path to devcontainer.json from repo root used to create Codespace.", - "type": [ - "string", - "null" - ], - "examples": [ - ".devcontainer/example/devcontainer.json" - ] - }, - "prebuild": { - "description": "Whether the codespace was created from a prebuild.", - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "last_used_at": { - "description": "Last known time this codespace was started.", - "type": "string", - "format": "date-time", - "examples": [ - "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" - ], - "type": "string", - "examples": [ - "Available" - ] - }, - "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", - "examples": [ - 0 - ] - }, - "behind": { - "description": "The number of commits the local repository is behind the remote.", - "type": "integer", - "examples": [ - 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", - "examples": [ - "main" - ] - } - } - }, - "location": { - "description": "The initally assigned location of a new codespace.", - "enum": [ - "EastUs", - "SouthEastAsia", - "WestEurope", - "WestUs2" - ], - "type": "string", - "examples": [ - "WestUs2" - ] - }, - "idle_timeout_minutes": { - "description": "The number of minutes of inactivity after which this codespace will be automatically stopped.", - "type": [ - "integer", - "null" - ], - "examples": [ - 60 - ] - }, - "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", - "null" - ], - "format": "uri" - }, - "pulls_url": { - "description": "API URL for the Pull Request associated with this codespace, if any.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "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", - "null" - ], - "items": { - "type": "string" - } - } - } - }, - "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", - "null" - ] - }, - "pending_operation_disabled_reason": { - "description": "Text to show user when codespace is disabled by a pending operation", - "type": [ - "string", - "null" - ] - }, - "idle_timeout_notice": { - "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy", - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ], - "examples": [ - 60 - ] - }, - "retention_expires_at": { - "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T20:01:12Z" - ] - }, - "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", - "null" - ], - "examples": [ - "you've used 100% of your spending limit for Codespaces" + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" ] } - }, - "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" ] } - } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] } }, "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": [] - } - ] - } + "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" + } + } } }, - "304": { - "description": "Not modified" - }, - "500": { - "description": "Internal Error", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -117571,9 +114126,141 @@ } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "members" + } + } + }, + "/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/list-issue-types", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/issue-types#list-issue-types-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": "array", + "items": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], + "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", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "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" + } + ] + } + } + } + } }, - "401": { - "description": "Requires authentication", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -117597,9 +114284,185 @@ } } } + } + }, + "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": "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 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", + "null" + ] + }, + "color": { + "description": "Color for the issue type.", + "type": [ + "string", + "null" + ], + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + } + }, + "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", + "null" + ], + "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", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "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": { @@ -117624,14 +114487,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" @@ -117639,11 +114506,11 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "errors": { + "type": "array", + "items": { + "type": "string" + } } } } @@ -117653,23 +114520,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organizations" + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "issue-types" } } }, - "/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}/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/delete-from-organization", + "operationId": "orgs/update-issue-type", "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/issue-types#update-issue-type-for-an-organization" }, "parameters": [ { @@ -117682,45 +114549,163 @@ } }, { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "codespace_name", + "name": "issue_type_id", + "description": "The unique identifier of the issue type.", "in": "path", "required": true, - "description": "The name of the codespace.", "schema": { - "type": "string" + "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", + "null" + ] + }, + "color": { + "description": "Color for the issue type.", + "type": [ + "string", + "null" + ], + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + } + }, + "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": { - "202": { - "description": "Accepted", + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "type": "object" + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], + "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", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "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": null + "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" + } } } } } }, - "304": { - "description": "Not modified" - }, - "500": { - "description": "Internal Error", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -117745,14 +114730,18 @@ } } }, - "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 Simple", + "description": "Validation Error Simple", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -117760,25 +114749,72 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "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.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "403": { - "description": "Forbidden", + { + "name": "issue_type_id", + "description": "The unique identifier of the issue type.", + "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": "Basic Error", - "description": "Basic Error", + "title": "Validation Error Simple", + "description": "Validation Error Simple", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -117786,11 +114822,11 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "errors": { + "type": "array", + "items": { + "type": "string" + } } } } @@ -117826,23 +114862,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organizations" + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "issue-types" } } }, - "/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}/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": [ - "codespaces" + "issues" ], - "operationId": "codespaces/stop-in-organization", + "operationId": "issues/list-for-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/issues/issues#list-organization-issues-assigned-to-the-authenticated-user" }, "parameters": [ { @@ -117855,22 +114891,112 @@ } }, { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, + "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": "codespace_name", - "in": "path", - "required": true, - "description": "The name of the codespace.", + "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": { @@ -117879,411 +115005,499 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "Codespace", - "description": "A codespace.", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "name": { - "description": "Automatically generated name of this codespace.", - "type": "string", - "examples": [ - "monalisa-octocat-hello-world-g4wpq6h95q" - ] - }, - "display_name": { - "description": "Display name for this codespace.", - "type": [ - "string", - "null" - ], - "examples": [ - "bookish space pancake" - ] - }, - "environment_id": { - "description": "UUID identifying this codespace's environment.", - "type": [ - "string", - "null" - ], - "examples": [ - "26a7c758-7299-4a73-b978-5a92a7ae98a0" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + "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" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + "node_id": { + "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" - ] - }, - "repository": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/1" + ] + }, + "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", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate", + null + ], + "examples": [ + "not_planned" + ] + }, + "title": { + "description": "Title of the issue", + "type": "string", + "examples": [ + "Widget creation fails in Safari on OS X 10.8" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ], + "examples": [ + "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?" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "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", + "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", + "null" + ] + }, + "color": { + "type": [ + "string", + "null" + ] + }, + "default": { + "type": "boolean" + } + } + } ] }, - "owner": { + "examples": [ + "bug", + "registration" + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "assignees": { + "type": [ + "array", + "null" + ], + "items": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -118450,1062 +115664,2168 @@ "type", "url" ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" + } + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string", + "examples": [ + "v1.0" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] + } }, - "pull": { - "type": "boolean" - } + "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" + ] } - }, - "role_name": { - "type": "string", - "examples": [ - "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", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# 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", - "null" - ], - "format": "uri" - } + ] + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" } }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "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" - ] - } + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] } - }, - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "type": "object", - "title": "Codespace machine", - "description": "A description of the machine powering a codespace.", - "properties": { - "name": { - "type": "string", - "description": "The name of the machine.", - "examples": [ - "standardLinux" - ] - }, - "display_name": { - "type": "string", - "description": "The display name of the machine includes cores, memory, and storage.", - "examples": [ - "4 cores, 16 GB RAM, 64 GB storage" - ] - }, - "operating_system": { - "type": "string", - "description": "The operating system of the machine.", - "examples": [ - "linux" - ] - }, - "storage_in_bytes": { - "type": "integer", - "description": "How much storage is available to the codespace.", - "examples": [ - 68719476736 - ] - }, - "memory_in_bytes": { - "type": "integer", - "description": "How much memory is available to the codespace.", - "examples": [ - 17179869184 - ] - }, - "cpus": { - "type": "integer", - "description": "How many cores are available to the codespace.", - "examples": [ - 4 - ] - }, - "prebuild_availability": { - "type": [ - "string", - "null" - ], - "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.", - "enum": [ - "none", - "ready", - "in_progress", - null - ], - "examples": [ - "ready" - ] - } + "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", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." }, - "required": [ - "name", - "display_name", - "operating_system", - "storage_in_bytes", - "memory_in_bytes", - "cpus", - "prebuild_availability" - ] - } - ] - }, - "devcontainer_path": { - "description": "Path to devcontainer.json from repo root used to create Codespace.", - "type": [ - "string", - "null" - ], - "examples": [ - ".devcontainer/example/devcontainer.json" - ] - }, - "prebuild": { - "description": "Whether the codespace was created from a prebuild.", - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "last_used_at": { - "description": "Last known time this codespace was started.", - "type": "string", - "format": "date-time", - "examples": [ - "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" - ], - "type": "string", - "examples": [ - "Available" - ] - }, - "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", - "examples": [ - 0 - ] + "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", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "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." + } }, - "behind": { - "description": "The number of commits the local repository is behind the remote.", - "type": "integer", - "examples": [ - 0 - ] + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } }, - "has_unpushed_changes": { - "description": "Whether the local repository has unpushed changes.", - "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" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "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", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "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" + } }, - "has_uncommitted_changes": { - "description": "Whether the local repository has uncommitted changes.", - "type": "boolean" + "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" + } }, - "ref": { - "description": "The current branch (or SHA if in detached HEAD state) of the local repository.", - "type": "string", - "examples": [ - "main" - ] - } - } - }, - "location": { - "description": "The initally assigned location of a new codespace.", - "enum": [ - "EastUs", - "SouthEastAsia", - "WestEurope", - "WestUs2" - ], - "type": "string", - "examples": [ - "WestUs2" - ] - }, - "idle_timeout_minutes": { - "description": "The number of minutes of inactivity after which this codespace will be automatically stopped.", - "type": [ - "integer", - "null" - ], - "examples": [ - 60 - ] - }, - "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", - "null" - ], - "format": "uri" - }, - "pulls_url": { - "description": "API URL for the Pull Request associated with this codespace, if any.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "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", - "null" - ], - "items": { - "type": "string" + "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" + ] } }, - "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", - "null" - ] - }, - "pending_operation_disabled_reason": { - "description": "Text to show user when codespace is disabled by a pending operation", - "type": [ - "string", - "null" - ] - }, - "idle_timeout_notice": { - "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy", - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ], - "examples": [ - 60 - ] - }, - "retention_expires_at": { - "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T20:01:12Z" - ] - }, - "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", - "null" - ], - "examples": [ - "you've used 100% of your spending limit for Codespaces" - ] - } - }, - "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" - ] + "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, - "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", + "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 - }, - "repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { + "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=", @@ -119525,1002 +117845,243 @@ "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, - "retention_period_minutes": 43200, - "retention_expires_at": null, - "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", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", - "recent_folders": [], - "template": 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}/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.", - "tags": [ - "copilot" - ], - "operationId": "copilot/get-copilot-seat-details-for-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-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" - } - } - ], - "responses": { - "200": { - "description": "The user's GitHub Copilot seat details, including usage.", - "content": { - "application/json": { - "schema": { - "title": "Copilot Business Seat Detail", - "description": "Information about a Copilot Business seat assignment for a user, team, or organization.", - "type": "object", - "properties": { - "assignee": { - "anyOf": [ - { - "type": "null" + "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 }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + "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 }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" + "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" }, - { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - } + "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 }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - } - ] - }, - "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", - "null" - ] - }, - "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", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] - } - ] - } + "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 }, - "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", - "examples": [ - "disabled | all" - ] - }, - "organization_selection_type": { - "type": "string", - "examples": [ - "disabled | all" - ] - }, - "group_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "62ab9291-fae2-468e-974b-7e45096d5021" - ] - }, - "group_name": { - "type": [ - "string", - "null" - ], - "examples": [ - "Justice League" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "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" - } + "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" }, - "required": [ - "id", - "url", - "members_url", - "name", - "html_url", - "slug", - "created_at", - "updated_at" - ] - } - ], - "type": [ - "null", - "object" - ] - }, - "pending_cancellation_date": { - "type": [ - "string", - "null" - ], - "format": "date", - "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", - "null" - ], - "format": "date-time", - "description": "Timestamp of user's last GitHub Copilot activity, in ISO 8601 format." - }, - "last_activity_editor": { - "type": [ - "string", - "null" - ], - "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": { - "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 + "forks": 1, + "open_issues": 1, + "watchers": 1 + }, + "author_association": "COLLABORATOR" } - } - } - } - } - } - }, - "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": { + }, + "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" } } } @@ -120550,30 +118111,27 @@ } } } - }, - "422": { - "description": "Copilot Business or Enterprise is not enabled for this organization or the user has a pending organization invitation." } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-user-management" + "enabledForGitHubApps": false, + "category": "issues", + "subcategory": "issues" } } }, - "/orgs/{org}/memberships/{username}": { + "/orgs/{org}/members": { "get": { - "summary": "Get organization membership for a user", - "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status.", + "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": [ "orgs" ], - "operationId": "orgs/get-membership-for-user", + "operationId": "orgs/list-members", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user" + "url": "https://docs.github.com/rest/orgs/members#list-organization-members" }, "parameters": [ { @@ -120586,12 +118144,51 @@ } }, { - "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": "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 } } ], @@ -120601,384 +118198,180 @@ "content": { "application/json": { "schema": { - "title": "Org Membership", - "description": "Org Membership", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/memberships/defunkt" - ] - }, - "state": { - "type": "string", - "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", - "enum": [ - "active", - "pending" - ], - "examples": [ - "active" - ] - }, - "role": { - "type": "string", - "description": "The user's membership type in the organization.", - "enum": [ - "admin", - "member", - "billing_manager" - ], - "examples": [ - "admin" - ] - }, - "direct_membership": { - "type": "boolean", - "description": "Whether the user has direct membership in the organization.", - "examples": [ - true - ] - }, - "enterprise_teams_providing_indirect_membership": { - "type": "array", - "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", - "maxItems": 100, - "items": { - "type": "string" + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - "examples": [ - "ent:team-one", - "ent:team-two" - ] - }, - "organization_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat" - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - } + "email": { + "type": [ + "string", + "null" + ] }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "permissions": { - "type": "object", - "properties": { - "can_create_repository": { - "type": "boolean" - } + "login": { + "type": "string", + "examples": [ + "octocat" + ] }, - "required": [ - "can_create_repository" - ] - } - }, - "required": [ - "state", - "role", - "organization_url", - "url", - "organization", - "user" - ] + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } }, "examples": { - "response-if-user-has-an-active-admin-membership-with-organization": { - "summary": "Response if user has an active admin membership with organization", - "value": { - "url": "https://api.github.com/orgs/octocat/memberships/defunkt", - "state": "active", - "role": "admin", - "organization_url": "https://api.github.com/orgs/octocat", - "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" - }, - "user": { + "default": { + "value": [ + { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -120998,20 +118391,32 @@ "type": "User", "site_admin": false } - } + ] } } } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } } }, - "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" @@ -121019,16 +118424,163 @@ "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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" + } + }, + { + "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": { + "type": "string" + } + } + } + }, + "404": { + "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", @@ -121063,19 +118615,39 @@ "category": "orgs", "subcategory": "members" } - }, - "put": { - "summary": "Set organization membership for a user", - "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", + } + }, + "/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": [ - "orgs" + "codespaces" ], - "operationId": "orgs/set-membership-for-user", + "operationId": "codespaces/get-codespaces-for-user-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/members#set-organization-membership-for-a-user" + "url": "https://docs.github.com/rest/codespaces/organizations#list-codespaces-for-a-user-in-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": "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.", @@ -121095,733 +118667,231 @@ } } ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "role": { - "type": "string", - "description": "The role to give the user in the organization. Can be one of: \n * `admin` - The user will become an owner of the organization. \n * `member` - The user will become a non-owner member of the organization.", - "enum": [ - "admin", - "member" - ], - "default": "member" - } - } - }, - "examples": { - "default": { - "summary": "Set an organization membership role for a user", - "value": { - "role": "member" - } - } - } - } - } - }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Org Membership", - "description": "Org Membership", "type": "object", + "required": [ + "total_count", + "codespaces" + ], "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat/memberships/defunkt" - ] - }, - "state": { - "type": "string", - "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", - "enum": [ - "active", - "pending" - ], - "examples": [ - "active" - ] - }, - "role": { - "type": "string", - "description": "The user's membership type in the organization.", - "enum": [ - "admin", - "member", - "billing_manager" - ], - "examples": [ - "admin" - ] - }, - "direct_membership": { - "type": "boolean", - "description": "Whether the user has direct membership in the organization.", - "examples": [ - true - ] + "total_count": { + "type": "integer" }, - "enterprise_teams_providing_indirect_membership": { - "type": "array", - "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", - "maxItems": 100, - "items": { - "type": "string" - }, - "examples": [ - "ent:team-one", - "ent:team-two" - ] - }, - "organization_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octocat" - ] - }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "permissions": { - "type": "object", - "properties": { - "can_create_repository": { - "type": "boolean" - } - }, - "required": [ - "can_create_repository" - ] - } - }, - "required": [ - "state", - "role", - "organization_url", - "url", - "organization", - "user" - ] - }, - "examples": { - "response-if-user-already-had-membership-with-organization": { - "summary": "Response if user has an active admin membership with organization", - "value": { - "url": "https://api.github.com/orgs/octocat/memberships/defunkt", - "state": "active", - "role": "admin", - "organization_url": "https://api.github.com/orgs/octocat", - "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" - }, - "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 - } - } - } - } - } - } - }, - "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": { + "codespaces": { "type": "array", "items": { "type": "object", - "required": [ - "code" - ], + "title": "Codespace", + "description": "A codespace.", "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] }, - "message": { - "type": "string" + "name": { + "description": "Automatically generated name of this codespace.", + "type": "string", + "examples": [ + "monalisa-octocat-hello-world-g4wpq6h95q" + ] }, - "code": { - "type": "string" + "display_name": { + "description": "Display name for this codespace.", + "type": [ + "string", + "null" + ], + "examples": [ + "bookish space pancake" + ] }, - "index": { - "type": "integer" + "environment_id": { + "description": "UUID identifying this codespace's environment.", + "type": [ + "string", + "null" + ], + "examples": [ + "26a7c758-7299-4a73-b978-5a92a7ae98a0" + ] }, - "value": { - "oneOf": [ - { + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { "type": [ "string", "null" ] }, - { + "email": { "type": [ - "integer", + "string", "null" ] }, - { + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { "type": [ - "array", + "string", "null" ], - "items": { - "type": "string" - } + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] - } - } - } - } - } - } - } - } - }, - "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": "members" - } - }, - "delete": { - "summary": "Remove organization membership for a user", - "description": "In order to remove a user's membership with an organization, the authenticated user must be an organization owner.\n\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.\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-membership-for-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/members#remove-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" - } - }, - { - "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": { - "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": "members" - } - } - }, - "/orgs/{org}/migrations": { - "get": { - "summary": "List organization migrations", - "description": "Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API).\n\nA list of `repositories` is only returned for export migrations.", - "tags": [ - "migrations" - ], - "operationId": "migrations/list-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/migrations/orgs#list-organization-migrations" - }, - "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": "exclude", - "description": "Exclude attributes from the API response to improve performance", - "in": "query", - "schema": { - "type": "array", - "items": { - "description": "Allowed values that can be passed to the exclude param.", - "enum": [ - "repositories" - ], - "type": "string", - "examples": [ - "repositories" - ] - } - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Migration", - "description": "A migration.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 79 - ] - }, - "owner": { - "anyOf": [ - { - "type": "null" }, - { + "billable_owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -121988,1088 +119058,1261 @@ "type", "url" ] - } - ] - }, - "guid": { - "type": "string", - "examples": [ - "0b989ba4-242f-11e5-81e1-c7b6966d2516" - ] - }, - "state": { - "type": "string", - "examples": [ - "pending" - ] - }, - "lock_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "exclude_metadata": { - "type": "boolean" - }, - "exclude_git_data": { - "type": "boolean" - }, - "exclude_attachments": { - "type": "boolean" - }, - "exclude_releases": { - "type": "boolean" - }, - "exclude_owner_projects": { - "type": "boolean" - }, - "org_metadata_only": { - "type": "boolean" - }, - "repositories": { - "type": "array", - "description": "The repositories included in the migration. Only returned for export migrations.", - "items": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" + }, + "repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" + }, + "role_name": { + "type": "string", + "examples": [ + "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", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# 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", + "null" + ], + "format": "uri" + } }, - "maintain": { - "type": "boolean" + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } } }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "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" + ] + } + } + } } }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] + "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 + } }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "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" + ] + }, + "machine": { + "anyOf": [ + { + "type": "null" + }, + { + "type": "object", + "title": "Codespace machine", + "description": "A description of the machine powering a codespace.", + "properties": { + "name": { + "type": "string", + "description": "The name of the machine.", + "examples": [ + "standardLinux" + ] + }, + "display_name": { + "type": "string", + "description": "The display name of the machine includes cores, memory, and storage.", + "examples": [ + "4 cores, 16 GB RAM, 64 GB storage" + ] + }, + "operating_system": { + "type": "string", + "description": "The operating system of the machine.", + "examples": [ + "linux" + ] + }, + "storage_in_bytes": { + "type": "integer", + "description": "How much storage is available to the codespace.", + "examples": [ + 68719476736 + ] + }, + "memory_in_bytes": { + "type": "integer", + "description": "How much memory is available to the codespace.", + "examples": [ + 17179869184 + ] + }, + "cpus": { + "type": "integer", + "description": "How many cores are available to the codespace.", + "examples": [ + 4 + ] + }, + "prebuild_availability": { + "type": [ + "string", + "null" + ], + "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.", + "enum": [ + "none", + "ready", + "in_progress", + null + ], + "examples": [ + "ready" + ] + } + }, + "required": [ + "name", + "display_name", + "operating_system", + "storage_in_bytes", + "memory_in_bytes", + "cpus", + "prebuild_availability" + ] } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { + ] + }, + "devcontainer_path": { + "description": "Path to devcontainer.json from repo root used to create Codespace.", + "type": [ + "string", + "null" + ], + "examples": [ + ".devcontainer/example/devcontainer.json" + ] + }, + "prebuild": { + "description": "Whether the codespace was created from a prebuild.", + "type": [ + "boolean", + "null" + ], + "examples": [ + false + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "last_used_at": { + "description": "Last known time this codespace was started.", + "type": "string", + "format": "date-time", + "examples": [ + "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" + ], + "type": "string", + "examples": [ + "Available" + ] + }, + "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", + "examples": [ + 0 + ] + }, + "behind": { + "description": "The number of commits the local repository is behind the remote.", + "type": "integer", + "examples": [ + 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", + "examples": [ + "main" + ] + } + } + }, + "location": { + "description": "The initally assigned location of a new codespace.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], + "type": "string", + "examples": [ + "WestUs2" + ] + }, + "idle_timeout_minutes": { + "description": "The number of minutes of inactivity after which this codespace will be automatically stopped.", + "type": [ + "integer", + "null" + ], + "examples": [ + 60 + ] + }, + "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", + "null" + ], + "format": "uri" + }, + "pulls_url": { + "description": "API URL for the Pull Request associated with this codespace, if any.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "recent_folders": { + "type": "array", + "items": { "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { + } + }, + "runtime_constraints": { + "type": "object", + "properties": { + "allowed_port_privacy_settings": { + "description": "The privacy settings a user can select from when forwarding a port.", + "type": [ + "array", + "null" + ], + "items": { "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" - ] - } - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octo-org/migrations/79" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2015-07-06T15:33:38-07:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2015-07-06T15:33:38-07:00" + "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", + "null" + ] + }, + "pending_operation_disabled_reason": { + "description": "Text to show user when codespace is disabled by a pending operation", + "type": [ + "string", + "null" + ] + }, + "idle_timeout_notice": { + "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy", + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ], + "examples": [ + 60 + ] + }, + "retention_expires_at": { + "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T20:01:12Z" + ] + }, + "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", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] + } + }, + "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" ] - }, - "node_id": { - "type": "string" - }, - "archive_url": { - "type": "string", - "format": "uri" - }, - "exclude": { - "description": "Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `\"repositories\"`.", - "type": "array", - "items": { - "description": "Allowed values that can be passed to the exclude parameter. The array can include any of: `\"repositories\"`.", - "type": "string" - } } - }, - "required": [ - "id", - "node_id", - "owner", - "guid", - "state", - "lock_repositories", - "exclude_metadata", - "exclude_git_data", - "exclude_attachments", - "exclude_releases", - "exclude_owner_projects", - "org_metadata_only", - "repositories", - "url", - "created_at", - "updated_at" - ] + } } }, "examples": { "default": { - "value": [ - { - "id": 79, - "owner": { - "login": "github", + "value": { + "total_count": 3, + "codespaces": [ + { "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 - }, - "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "state": "pending", - "lock_repositories": true, - "exclude_attachments": false, - "exclude_releases": false, - "exclude_owner_projects": false, - "repositories": [ - { + "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", @@ -123136,78 +120379,434 @@ "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 + "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 }, - "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://api.github.com/licenses/mit" + "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 }, - "forks": 1, - "open_issues": 1, - "watchers": 1 - } - ], - "url": "https://api.github.com/orgs/octo-org/migrations/79", - "created_at": "2015-07-06T15:33:38-07:00", - "updated_at": "2015-07-06T15:33:38-07:00", - "node_id": "MDQ6VXNlcjE=" - } - ] + "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\"", + } + }, + "304": { + "description": "Not modified" + }, + "500": { + "description": "Internal Error", + "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" + } + } + } + } + } + }, + "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" + } + } } } } @@ -123216,20 +120815,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "category": "migrations", - "subcategory": "orgs" + "category": "codespaces", + "subcategory": "organizations" } - }, - "post": { - "summary": "Start an organization migration", - "description": "Initiates the generation of a migration archive.", + } + }, + "/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": [ - "migrations" + "codespaces" ], - "operationId": "migrations/start-for-org", + "operationId": "codespaces/delete-from-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/migrations/orgs#start-an-organization-migration" + "url": "https://docs.github.com/rest/codespaces/organizations#delete-a-codespace-from-the-organization" }, "parameters": [ { @@ -123240,1685 +120841,610 @@ "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" + } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "repositories": { - "type": "array", - "description": "A list of arrays indicating which repositories should be migrated.", - "items": { + "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" } - }, - "lock_repositories": { - "type": "boolean", - "description": "Indicates whether repositories should be locked (to prevent manipulation) while migrating data.", - "default": false, - "examples": [ - true - ] - }, - "exclude_metadata": { - "type": "boolean", - "description": "Indicates whether metadata should be excluded and only git source should be included for the migration.", - "default": false - }, - "exclude_git_data": { - "type": "boolean", - "description": "Indicates whether the repository git data should be excluded from the migration.", - "default": false - }, - "exclude_attachments": { - "type": "boolean", - "description": "Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).", - "default": false, - "examples": [ - true - ] - }, - "exclude_releases": { - "type": "boolean", - "description": "Indicates whether releases should be excluded from the migration (to reduce migration archive file size).", - "default": false, - "examples": [ - true - ] - }, - "exclude_owner_projects": { - "type": "boolean", - "description": "Indicates whether projects owned by the organization or users should be excluded. from the migration.", - "default": false, - "examples": [ - true - ] - }, - "org_metadata_only": { - "type": "boolean", - "description": "Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).", - "default": false, - "examples": [ - true - ] - }, - "exclude": { - "type": "array", - "description": "Exclude related items from being returned in the response in order to improve performance of the request.", - "items": { - "type": "string", - "enum": [ - "repositories" - ] + } + } + } + } + }, + "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": [ - "repositories" - ] - }, - "examples": { - "default": { - "value": { - "repositories": [ - "github/Hello-World" - ], - "lock_repositories": 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": { + "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": { - "201": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Migration", - "description": "A migration.", "type": "object", + "title": "Codespace", + "description": "A codespace.", "properties": { "id": { "type": "integer", "format": "int64", "examples": [ - 79 - ] - }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + 1 ] }, - "guid": { + "name": { + "description": "Automatically generated name of this codespace.", "type": "string", "examples": [ - "0b989ba4-242f-11e5-81e1-c7b6966d2516" + "monalisa-octocat-hello-world-g4wpq6h95q" ] }, - "state": { - "type": "string", + "display_name": { + "description": "Display name for this codespace.", + "type": [ + "string", + "null" + ], "examples": [ - "pending" + "bookish space pancake" ] }, - "lock_repositories": { - "type": "boolean", + "environment_id": { + "description": "UUID identifying this codespace's environment.", + "type": [ + "string", + "null" + ], "examples": [ - true + "26a7c758-7299-4a73-b978-5a92a7ae98a0" ] }, - "exclude_metadata": { - "type": "boolean" - }, - "exclude_git_data": { - "type": "boolean" - }, - "exclude_attachments": { - "type": "boolean" - }, - "exclude_releases": { - "type": "boolean" - }, - "exclude_owner_projects": { - "type": "boolean" - }, - "org_metadata_only": { - "type": "boolean" - }, - "repositories": { - "type": "array", - "description": "The repositories included in the migration. Only returned for export migrations.", - "items": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } - } + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - "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" - ] - } - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/octo-org/migrations/79" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2015-07-06T15:33:38-07:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2015-07-06T15:33:38-07:00" - ] - }, - "node_id": { - "type": "string" - }, - "archive_url": { - "type": "string", - "format": "uri" - }, - "exclude": { - "description": "Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `\"repositories\"`.", - "type": "array", - "items": { - "description": "Allowed values that can be passed to the exclude parameter. The array can include any of: `\"repositories\"`.", - "type": "string" - } - } - }, - "required": [ - "id", - "node_id", - "owner", - "guid", - "state", - "lock_repositories", - "exclude_metadata", - "exclude_git_data", - "exclude_attachments", - "exclude_releases", - "exclude_owner_projects", - "org_metadata_only", - "repositories", - "url", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 79, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "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 - }, - "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "state": "pending", - "lock_repositories": true, - "exclude_attachments": false, - "exclude_releases": false, - "exclude_owner_projects": false, - "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" + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" ], - "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://api.github.com/licenses/mit" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } - ], - "url": "https://api.github.com/orgs/octo-org/migrations/79", - "created_at": "2015-07-06T15:33:38-07:00", - "updated_at": "2015-07-06T15:33:38-07:00" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/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" + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } + "billable_owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "migrations", - "subcategory": "orgs" - } - } - }, - "/orgs/{org}/migrations/{migration_id}": { - "get": { - "summary": "Get an organization migration status", - "description": "Fetches the status of a migration.\n\nThe `state` of a migration can be one of the following values:\n\n* `pending`, which means the migration hasn't started yet.\n* `exporting`, which means the migration is in progress.\n* `exported`, which means the migration finished successfully.\n* `failed`, which means the migration failed.", - "tags": [ - "migrations" - ], - "operationId": "migrations/get-status-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "migration_id", - "description": "The unique identifier of the migration.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "exclude", - "description": "Exclude attributes from the API response to improve performance", - "in": "query", - "schema": { - "type": "array", - "items": { - "description": "Allowed values that can be passed to the exclude param.", - "enum": [ - "repositories" - ], - "type": "string", - "examples": [ - "repositories" - ] - } - } - } - ], - "responses": { - "200": { - "description": "* `pending`, which means the migration hasn't started yet.\n* `exporting`, which means the migration is in progress.\n* `exported`, which means the migration finished successfully.\n* `failed`, which means the migration failed.", - "content": { - "application/json": { - "schema": { - "title": "Migration", - "description": "A migration.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 79 + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, - "owner": { - "anyOf": [ - { - "type": "null" + "repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] }, - { + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -125085,1068 +121611,1023 @@ "type", "url" ] - } - ] - }, - "guid": { - "type": "string", - "examples": [ - "0b989ba4-242f-11e5-81e1-c7b6966d2516" - ] - }, - "state": { - "type": "string", - "examples": [ - "pending" - ] - }, - "lock_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "exclude_metadata": { - "type": "boolean" - }, - "exclude_git_data": { - "type": "boolean" - }, - "exclude_attachments": { - "type": "boolean" - }, - "exclude_releases": { - "type": "boolean" - }, - "exclude_owner_projects": { - "type": "boolean" - }, - "org_metadata_only": { - "type": "boolean" - }, - "repositories": { - "type": "array", - "description": "The repositories included in the migration. Only returned for export migrations.", - "items": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "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", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# 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", + "null" + ], + "format": "uri" + } }, - "topics": { - "type": "array", - "items": { + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { "type": "string" } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "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" + ] + } } } } }, - "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" - ] - } + "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" + ] }, - "url": { - "type": "string", - "format": "uri", + "machine": { + "anyOf": [ + { + "type": "null" + }, + { + "type": "object", + "title": "Codespace machine", + "description": "A description of the machine powering a codespace.", + "properties": { + "name": { + "type": "string", + "description": "The name of the machine.", + "examples": [ + "standardLinux" + ] + }, + "display_name": { + "type": "string", + "description": "The display name of the machine includes cores, memory, and storage.", + "examples": [ + "4 cores, 16 GB RAM, 64 GB storage" + ] + }, + "operating_system": { + "type": "string", + "description": "The operating system of the machine.", + "examples": [ + "linux" + ] + }, + "storage_in_bytes": { + "type": "integer", + "description": "How much storage is available to the codespace.", + "examples": [ + 68719476736 + ] + }, + "memory_in_bytes": { + "type": "integer", + "description": "How much memory is available to the codespace.", + "examples": [ + 17179869184 + ] + }, + "cpus": { + "type": "integer", + "description": "How many cores are available to the codespace.", + "examples": [ + 4 + ] + }, + "prebuild_availability": { + "type": [ + "string", + "null" + ], + "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.", + "enum": [ + "none", + "ready", + "in_progress", + null + ], + "examples": [ + "ready" + ] + } + }, + "required": [ + "name", + "display_name", + "operating_system", + "storage_in_bytes", + "memory_in_bytes", + "cpus", + "prebuild_availability" + ] + } + ] + }, + "devcontainer_path": { + "description": "Path to devcontainer.json from repo root used to create Codespace.", + "type": [ + "string", + "null" + ], "examples": [ - "https://api.github.com/orgs/octo-org/migrations/79" + ".devcontainer/example/devcontainer.json" + ] + }, + "prebuild": { + "description": "Whether the codespace was created from a prebuild.", + "type": [ + "boolean", + "null" + ], + "examples": [ + false ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2015-07-06T15:33:38-07:00" + "2011-01-26T19:01:12Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2015-07-06T15:33:38-07:00" + "2011-01-26T19:01:12Z" ] }, - "node_id": { - "type": "string" + "last_used_at": { + "description": "Last known time this codespace was started.", + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] }, - "archive_url": { + "state": { + "description": "State of this codespace.", + "enum": [ + "Unknown", + "Created", + "Queued", + "Provisioning", + "Available", + "Awaiting", + "Unavailable", + "Deleted", + "Moved", + "Shutdown", + "Archived", + "Starting", + "ShuttingDown", + "Failed", + "Exporting", + "Updating", + "Rebuilding" + ], + "type": "string", + "examples": [ + "Available" + ] + }, + "url": { + "description": "API URL for this codespace.", "type": "string", "format": "uri" }, - "exclude": { - "description": "Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `\"repositories\"`.", + "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", + "examples": [ + 0 + ] + }, + "behind": { + "description": "The number of commits the local repository is behind the remote.", + "type": "integer", + "examples": [ + 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", + "examples": [ + "main" + ] + } + } + }, + "location": { + "description": "The initally assigned location of a new codespace.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], + "type": "string", + "examples": [ + "WestUs2" + ] + }, + "idle_timeout_minutes": { + "description": "The number of minutes of inactivity after which this codespace will be automatically stopped.", + "type": [ + "integer", + "null" + ], + "examples": [ + 60 + ] + }, + "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", + "null" + ], + "format": "uri" + }, + "pulls_url": { + "description": "API URL for the Pull Request associated with this codespace, if any.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "recent_folders": { "type": "array", "items": { - "description": "Allowed values that can be passed to the exclude parameter. The array can include any of: `\"repositories\"`.", "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", + "null" + ], + "items": { + "type": "string" + } + } + } + }, + "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", + "null" + ] + }, + "pending_operation_disabled_reason": { + "description": "Text to show user when codespace is disabled by a pending operation", + "type": [ + "string", + "null" + ] + }, + "idle_timeout_notice": { + "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy", + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ], + "examples": [ + 60 + ] + }, + "retention_expires_at": { + "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T20:01:12Z" + ] + }, + "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", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ "id", - "node_id", + "name", + "environment_id", "owner", - "guid", + "billable_owner", + "repository", + "machine", + "prebuild", + "created_at", + "updated_at", + "last_used_at", "state", - "lock_repositories", - "exclude_metadata", - "exclude_git_data", - "exclude_attachments", - "exclude_releases", - "exclude_owner_projects", - "org_metadata_only", - "repositories", "url", - "created_at", - "updated_at" + "git_status", + "location", + "idle_timeout_minutes", + "web_url", + "machines_url", + "start_url", + "stop_url", + "pulls_url", + "recent_folders" ] }, "examples": { "default": { "value": { - "id": 79, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "id": 1, + "name": "monalisa-octocat-hello-world-g4wpq6h95q", + "environment_id": "26a7c758-7299-4a73-b978-5a92a7ae98a0", "owner": { - "login": "github", + "login": "octocat", "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", + "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", + "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", @@ -126154,152 +122635,145 @@ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", - "site_admin": true + "site_admin": false }, - "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "state": "exported", - "lock_repositories": true, - "exclude_attachments": false, - "exclude_releases": false, - "exclude_owner_projects": false, - "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://api.github.com/licenses/mit" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 - } - ], - "url": "https://api.github.com/orgs/octo-org/migrations/79", - "created_at": "2015-07-06T15:33:38-07:00", - "updated_at": "2015-07-06T15:33:38-07:00" + "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, + "retention_period_minutes": 43200, + "retention_expires_at": null, + "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", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", + "recent_folders": [], + "template": null } } } } } }, - "404": { - "description": "Resource not found", + "304": { + "description": "Not modified" + }, + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -126323,54 +122797,9 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "migrations", - "subcategory": "orgs" - } - } - }, - "/orgs/{org}/migrations/{migration_id}/archive": { - "get": { - "summary": "Download an organization migration archive", - "description": "Fetches the URL to a migration archive.", - "tags": [ - "migrations" - ], - "operationId": "migrations/download-archive-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "migration_id", - "description": "The unique identifier of the migration.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "302": { - "description": "Response" }, - "404": { - "description": "Resource not found", + "401": { + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -126394,52 +122823,9 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "migrations", - "subcategory": "orgs" - } - }, - "delete": { - "summary": "Delete an organization migration archive", - "description": "Deletes a previous migration archive. Migration archives are automatically deleted after seven days.", - "tags": [ - "migrations" - ], - "operationId": "migrations/delete-archive-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "migration_id", - "description": "The unique identifier of the migration.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" }, - "404": { - "description": "Resource not found", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -126463,60 +122849,6 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "migrations", - "subcategory": "orgs" - } - } - }, - "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock": { - "delete": { - "summary": "Unlock an organization repository", - "description": "Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data.", - "tags": [ - "migrations" - ], - "operationId": "migrations/unlock-repo-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "migration_id", - "description": "The unique identifier of the migration.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "repo_name", - "description": "repo_name parameter", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" }, "404": { "description": "Resource not found", @@ -126548,22 +122880,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "category": "migrations", - "subcategory": "orgs" + "category": "codespaces", + "subcategory": "organizations" } } }, - "/orgs/{org}/migrations/{migration_id}/repositories": { + "/orgs/{org}/members/{username}/copilot": { "get": { - "summary": "List repositories in an organization migration", - "description": "List all the repositories for this organization migration.", + "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 [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": [ - "migrations" + "copilot" ], - "operationId": "migrations/list-repos-for-org", + "operationId": "copilot/get-copilot-seat-details-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration" + "url": "https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-user" }, "parameters": [ { @@ -126576,1950 +122908,26 @@ } }, { - "name": "migration_id", - "description": "The unique identifier of the migration.", + "name": "username", + "description": "The handle for the GitHub user account.", "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 + "type": "string" } } ], "responses": { "200": { - "description": "Response", + "description": "The user's GitHub Copilot seat details, including usage.", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "examples": [ - "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", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# 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", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "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": [ - { - "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": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "has_discussions": false, - "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 - }, - "security_and_analysis": { - "advanced_security": { - "status": "enabled" - }, - "secret_scanning": { - "status": "enabled" - }, - "secret_scanning_push_protection": { - "status": "disabled" - }, - "secret_scanning_non_provider_patterns": { - "status": "disabled" - } - } - } - ] - } - } - } - }, - "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": false, - "category": "migrations", - "subcategory": "orgs" - } - } - }, - "/orgs/{org}/organization-roles": { - "get": { - "summary": "Get all organization roles for an organization", - "description": "Lists the organization roles available in this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/list-org-roles", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/organization-roles#get-all-organization-roles-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 - list of organization roles", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "total_count": { - "type": "integer", - "description": "The total number of organization roles available to the organization." - }, - "roles": { - "type": "array", - "description": "The list of organization roles available to the organization.", - "items": { - "title": "Organization Role", - "description": "Organization roles", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the role.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "The name of the role.", - "type": "string" - }, - "description": { - "description": "A short description about who this role is for or what permissions it grants.", - "type": [ - "string", - "null" - ] - }, - "base_role": { - "type": [ - "string", - "null" - ], - "description": "The system role from which this role inherits permissions.", - "enum": [ - "read", - "triage", - "write", - "maintain", - "admin", - null - ] - }, - "source": { - "type": [ - "string", - "null" - ], - "description": "Source answers the question, \"where did this role come from?\"", - "enum": [ - "Organization", - "Enterprise", - "Predefined", - null - ] - }, - "permissions": { - "description": "A list of permissions included in this role.", - "type": "array", - "items": { - "type": "string" - } - }, - "organization": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "description": "The date and time the role was created.", - "type": "string", - "format": "date-time" - }, - "updated_at": { - "description": "The date and time the role was last updated.", - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "name", - "permissions", - "organization", - "created_at", - "updated_at" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 2, - "roles": [ - { - "id": 8030, - "name": "Custom Role Manager", - "description": "Permissions to manage custom roles within an org", - "permissions": [ - "write_organization_custom_repo_role", - "write_organization_custom_org_role", - "read_organization_custom_repo_role", - "read_organization_custom_org_role" - ], - "organization": { - "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 - }, - "created_at": "2022-07-04T22:19:11Z", - "updated_at": "2022-07-04T22:20:11Z" - }, - { - "id": 8031, - "name": "Auditor", - "description": "Permissions to read the organization audit log", - "permissions": [ - "read_audit_logs" - ], - "organization": { - "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 - }, - "created_at": "2022-07-04T22:19:11Z", - "updated_at": "2022-07-04T22:20:11Z" - } - ] - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "organization-roles" - } - } - }, - "/orgs/{org}/organization-roles/teams/{team_slug}": { - "delete": { - "summary": "Remove all organization roles for a team", - "description": "Removes all assigned organization roles from a team. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/revoke-all-org-roles-team", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "organization-roles" - } - } - }, - "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}": { - "put": { - "summary": "Assign an organization role to a team", - "description": "Assigns an organization role to a team in an organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/assign-team-to-org-role", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-team" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "role_id", - "description": "The unique identifier of the role.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "404": { - "description": "Response if the organization, team or role does not exist." - }, - "422": { - "description": "Response if the organization roles feature is not enabled for the organization, or validation failed." - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "organization-roles" - } - }, - "delete": { - "summary": "Remove an organization role from a team", - "description": "Removes an organization role from a team. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/revoke-org-role-team", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-team" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "role_id", - "description": "The unique identifier of the role.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "organization-roles" - } - } - }, - "/orgs/{org}/organization-roles/users/{username}": { - "delete": { - "summary": "Remove all organization roles for a user", - "description": "Revokes all assigned organization roles from a user. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/revoke-all-org-roles-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-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" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "organization-roles" - } - } - }, - "/orgs/{org}/organization-roles/users/{username}/{role_id}": { - "put": { - "summary": "Assign an organization role to a user", - "description": "Assigns an organization role to a member of an organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/assign-user-to-org-role", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-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": "role_id", - "description": "The unique identifier of the role.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "404": { - "description": "Response if the organization, user or role does not exist." - }, - "422": { - "description": "Response if the organization roles feature is not enabled enabled for the organization, the validation failed, or the user is not an organization member." - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "organization-roles" - } - }, - "delete": { - "summary": "Remove an organization role from a user", - "description": "Remove an organization role from a user. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/revoke-org-role-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-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": "role_id", - "description": "The unique identifier of the role.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "organization-roles" - } - } - }, - "/orgs/{org}/organization-roles/{role_id}": { - "get": { - "summary": "Get an organization role", - "description": "Gets an organization role that is available to this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/get-org-role", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "role_id", - "description": "The unique identifier of the role.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Organization Role", - "description": "Organization roles", + "title": "Copilot Business Seat Detail", + "description": "Information about a Copilot Business seat assignment for a user, team, or organization.", "type": "object", "properties": { - "id": { - "description": "The unique identifier of the role.", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "The name of the role.", - "type": "string" - }, - "description": { - "description": "A short description about who this role is for or what permissions it grants.", - "type": [ - "string", - "null" - ] - }, - "base_role": { - "type": [ - "string", - "null" - ], - "description": "The system role from which this role inherits permissions.", - "enum": [ - "read", - "triage", - "write", - "maintain", - "admin", - null - ] - }, - "source": { - "type": [ - "string", - "null" - ], - "description": "Source answers the question, \"where did this role come from?\"", - "enum": [ - "Organization", - "Enterprise", - "Predefined", - null - ] - }, - "permissions": { - "description": "A list of permissions included in this role.", - "type": "array", - "items": { - "type": "string" - } - }, - "organization": { + "assignee": { "anyOf": [ { "type": "null" @@ -128694,455 +123102,492 @@ } ] }, - "created_at": { - "description": "The date and time the role was created.", - "type": "string", - "format": "date-time" - }, - "updated_at": { - "description": "The date and time the role was last updated.", - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "name", - "permissions", - "organization", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 8030, - "name": "Custom Role Manager", - "description": "Permissions to manage custom roles within an org", - "permissions": [ - "write_organization_custom_repo_role", - "write_organization_custom_org_role", - "read_organization_custom_repo_role", - "read_organization_custom_org_role" - ], - "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" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/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" + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + } + ] + }, + "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", + "null" + ] + }, + "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" + } }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] } - } - ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "organization-roles" - } - } - }, - "/orgs/{org}/organization-roles/{role_id}/teams": { - "get": { - "summary": "List teams that are assigned to an organization role", - "description": "Lists the teams that are assigned to an organization role. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, you must be an administrator for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/list-org-role-teams", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "role_id", - "description": "The unique identifier of the role.", - "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 - List of assigned teams", - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "List of teams assigned to the organization role", - "items": { - "title": "A Role Assignment for a Team", - "description": "The Relationship a Team has with a role.", - "type": "object", - "properties": { - "assignment": { - "type": "string", - "description": "Determines if the team has a direct, indirect, or mixed relationship to a role", - "enum": [ - "direct", - "indirect", - "mixed" - ], - "examples": [ - "direct" - ] - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "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": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } + { + "title": "Enterprise Team", + "description": "Group of enterprise owners and/or members", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] - } - ] - } + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "sync_to_organizations": { + "type": "string", + "examples": [ + "disabled | all" + ] + }, + "organization_selection_type": { + "type": "string", + "examples": [ + "disabled | all" + ] + }, + "group_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "62ab9291-fae2-468e-974b-7e45096d5021" + ] + }, + "group_name": { + "type": [ + "string", + "null" + ], + "examples": [ + "Justice League" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "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" + ] + } + ], + "type": [ + "null", + "object" + ] }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] - } + "pending_cancellation_date": { + "type": [ + "string", + "null" + ], + "format": "date", + "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", + "null" + ], + "format": "date-time", + "description": "Timestamp of user's last GitHub Copilot activity, in ISO 8601 format." + }, + "last_activity_editor": { + "type": [ + "string", + "null" + ], + "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": [ - { + "value": { + "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", @@ -129157,46 +123602,139 @@ "repositories_url": "https://api.github.com/teams/1/repos", "parent": null } - ] + } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", + } + }, + "500": { + "description": "Internal Error", + "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" + } + } + } + } + } + }, + "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": "Response if the organization or role does not exist." + "description": "Resource not found", + "content": { + "application/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": "Response if the organization roles feature is not enabled or validation failed." + "description": "Copilot Business or Enterprise is not enabled for this organization or the user has a pending organization invitation." } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "organization-roles" + "category": "copilot", + "subcategory": "copilot-user-management" } } }, - "/orgs/{org}/organization-roles/{role_id}/users": { + "/orgs/{org}/memberships/{username}": { "get": { - "summary": "List users that are assigned to an organization role", - "description": "Lists organization members that are assigned to an organization role. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, you must be an administrator for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Get organization membership for a user", + "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status.", "tags": [ "orgs" ], - "operationId": "orgs/list-org-role-users", + "operationId": "orgs/get-membership-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role" + "url": "https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user" }, "parameters": [ { @@ -129209,69 +123747,211 @@ } }, { - "name": "role_id", - "description": "The unique identifier of the role.", + "name": "username", + "description": "The handle for the GitHub user account.", "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 + "type": "string" } } ], "responses": { "200": { - "description": "Response - List of assigned users", + "description": "Response", "content": { "application/json": { "schema": { - "type": "array", - "description": "List of users assigned to the organization role", - "items": { - "title": "A Role Assignment for a User", - "description": "The Relationship a User has with a role.", - "type": "object", - "properties": { - "assignment": { - "type": "string", - "description": "Determines if the user has a direct, indirect, or mixed relationship to a role", - "enum": [ - "direct", - "indirect", - "mixed" - ], - "examples": [ - "direct" - ] + "title": "Org Membership", + "description": "Org Membership", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/memberships/defunkt" + ] + }, + "state": { + "type": "string", + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "enum": [ + "active", + "pending" + ], + "examples": [ + "active" + ] + }, + "role": { + "type": "string", + "description": "The user's membership type in the organization.", + "enum": [ + "admin", + "member", + "billing_manager" + ], + "examples": [ + "admin" + ] + }, + "direct_membership": { + "type": "boolean", + "description": "Whether the user has direct membership in the organization.", + "examples": [ + true + ] + }, + "enterprise_teams_providing_indirect_membership": { + "type": "array", + "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", + "maxItems": 100, + "items": { + "type": "string" }, - "inherited_from": { - "description": "Team the user has gotten the role through", - "type": "array", - "items": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", + "examples": [ + "ent:team-one", + "ent:team-two" + ] + }, + "organization_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, "id": { - "description": "Unique identifier of the team", "type": "integer", + "format": "int64", "examples": [ 1 ] @@ -129279,554 +123959,187 @@ "node_id": { "type": "string", "examples": [ - "MDQ6VGVhbTE=" + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" ] }, "url": { - "description": "URL for the team", "type": "string", "format": "uri", "examples": [ - "https://api.github.com/organizations/1/team/1" + "https://api.github.com/users/octocat" ] }, - "members_url": { + "html_url": { "type": "string", + "format": "uri", "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" + "https://github.com/octocat" ] }, - "name": { - "description": "Name of the team", + "followers_url": { "type": "string", + "format": "uri", "examples": [ - "Justice League" + "https://api.github.com/users/octocat/followers" ] }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], + "following_url": { + "type": "string", "examples": [ - "A great team." + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "permission": { - "description": "Permission that the team will have for its repositories", + "gists_url": { "type": "string", "examples": [ - "admin" + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "privacy": { - "description": "The level of privacy this team should have", + "starred_url": { "type": "string", "examples": [ - "closed" + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "notification_setting": { - "description": "The notification setting the team has set", + "subscriptions_url": { "type": "string", + "format": "uri", "examples": [ - "notifications_enabled" + "https://api.github.com/users/octocat/subscriptions" ] }, - "html_url": { + "organizations_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/orgs/rails/teams/core" + "https://api.github.com/users/octocat/orgs" ] }, - "repositories_url": { + "repos_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/organizations/1/team/1/repos" + "https://api.github.com/users/octocat/repos" ] }, - "slug": { + "events_url": { "type": "string", "examples": [ - "justice-league" + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { "type": "string", "examples": [ - "uid=example,ou=users,dc=github,dc=com" + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", "id", "node_id", - "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" ] } - }, - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + ] }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "permissions": { + "type": "object", + "properties": { + "can_create_repository": { + "type": "boolean" + } + }, + "required": [ + "can_create_repository" + ] + } + }, + "required": [ + "state", + "role", + "organization_url", + "url", + "organization", + "user" + ] }, "examples": { - "default": { - "value": [ - { - "login": "octocat", + "response-if-user-has-an-active-admin-membership-with-organization": { + "summary": "Response if user has an active admin membership with organization", + "value": { + "url": "https://api.github.com/orgs/octocat/memberships/defunkt", + "state": "active", + "role": "admin", + "organization_url": "https://api.github.com/orgs/octocat", + "organization": { + "login": "github", "id": 1, - "node_id": "MDQ6VXNlcjE=", + "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", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "404": { - "description": "Response if the organization or role does not exist." - }, - "422": { - "description": "Response if the organization roles feature is not enabled or validation failed." - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "organization-roles" - } - } - }, - "/orgs/{org}/outside_collaborators": { - "get": { - "summary": "List outside collaborators for an organization", - "description": "List all users who are outside collaborators of an organization.", - "tags": [ - "orgs" - ], - "operationId": "orgs/list-outside-collaborators", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "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) enabled will be returned. `2fa_insecure` means that only outside collaborators 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.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "2fa_disabled", - "2fa_insecure", - "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", - "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": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "description": "A great organization" }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "examples": { - "default": { - "value": [ - { + "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -129846,116 +124159,40 @@ "type": "User", "site_admin": false } - ] + } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "outside-collaborators" - } - } - }, - "/orgs/{org}/outside_collaborators/{username}": { - "put": { - "summary": "Convert an organization member to outside collaborator", - "description": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"[Converting an organization member to an outside collaborator](https://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)\". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"", - "tags": [ - "orgs" - ], - "operationId": "orgs/convert-member-to-outside-collaborator", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator" - }, - "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" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "async": { - "type": "boolean", - "description": "When set to `true`, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.", - "default": false - } - } - }, - "examples": { - "202": { - "summary": "Status code 202, asynchronous request", - "value": { - "async": true - } - }, - "204": { - "summary": "Status code 204, synchronous request", - "value": null - } - } - } - } - }, - "responses": { - "202": { - "description": "User is getting converted asynchronously", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "properties": {}, - "additionalProperties": false - }, - "examples": { - "202": { - "value": null + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } } } } } }, - "204": { - "description": "User was converted" - }, "403": { - "description": "Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"" - }, - "404": { - "description": "Resource not found", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -129985,19 +124222,19 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", - "subcategory": "outside-collaborators" + "subcategory": "members" } }, - "delete": { - "summary": "Remove outside collaborator from an organization", - "description": "Removing a user from this list will remove them from all the organization's repositories.", + "put": { + "summary": "Set organization membership for a user", + "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", "tags": [ "orgs" ], - "operationId": "orgs/remove-outside-collaborator", + "operationId": "orgs/set-membership-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization" + "url": "https://docs.github.com/rest/orgs/members#set-organization-membership-for-a-user" }, "parameters": [ { @@ -130019,1496 +124256,201 @@ } } ], - "responses": { - "204": { - "description": "Response" - }, - "422": { - "description": "Unprocessable Entity if user is a member of the organization", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "role": { + "type": "string", + "description": "The role to give the user in the organization. Can be one of: \n * `admin` - The user will become an owner of the organization. \n * `member` - The user will become a non-owner member of the organization.", + "enum": [ + "admin", + "member" + ], + "default": "member" } - }, - "examples": { - "response-if-user-is-a-member-of-the-organization": { - "value": { - "message": "You cannot specify an organization member to remove as an outside collaborator.", - "documentation_url": "https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization" - } + } + }, + "examples": { + "default": { + "summary": "Set an organization membership role for a user", + "value": { + "role": "member" } } } } } }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "outside-collaborators" - } - } - }, - "/orgs/{org}/packages": { - "get": { - "summary": "List packages for an organization", - "description": "Lists packages in an organization readable by the user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", - "tags": [ - "packages" - ], - "operationId": "packages/list-packages-for-organization", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/packages/packages#list-packages-for-an-organization" - }, - "parameters": [ - { - "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 (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", - "in": "query", - "required": true, - "schema": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - } - }, - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "visibility", - "description": "The selected visibility of the packages. This parameter is optional and only filters an existing result set.\n\nThe `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`.\nFor the list of GitHub Packages registries that support granular permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "public", - "private", - "internal" - ] - } - }, - { - "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": "array", - "items": { - "title": "Package", - "description": "A software package", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the package.", - "type": "integer", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the package.", - "type": "string", - "examples": [ - "super-linter" - ] - }, - "package_type": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ], - "examples": [ - "docker" - ] - }, - "url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/packages/container/super-linter" - ] - }, - "html_url": { - "type": "string", - "examples": [ - "https://github.com/orgs/github/packages/container/package/super-linter" - ] - }, - "version_count": { - "description": "The number of versions of the package.", - "type": "integer", - "examples": [ - 1 - ] - }, - "visibility": { - "type": "string", - "enum": [ - "private", - "public" - ], - "examples": [ - "private" - ] + "title": "Org Membership", + "description": "Org Membership", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octocat/memberships/defunkt" + ] + }, + "state": { + "type": "string", + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "enum": [ + "active", + "pending" + ], + "examples": [ + "active" + ] + }, + "role": { + "type": "string", + "description": "The user's membership type in the organization.", + "enum": [ + "admin", + "member", + "billing_manager" + ], + "examples": [ + "admin" + ] + }, + "direct_membership": { + "type": "boolean", + "description": "Whether the user has direct membership in the organization.", + "examples": [ + true + ] + }, + "enterprise_teams_providing_indirect_membership": { + "type": "array", + "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", + "maxItems": 100, + "items": { + "type": "string" }, - "owner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "repository": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "examples": [ - "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", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# 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", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "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" - ] - } - ] - }, - "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" - } - } - } - } - } - }, - "400": { - "description": "The value of `per_page` multiplied by `page` cannot be greater than 10000." - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "packages", - "subcategory": "packages" - } - } - }, - "/orgs/{org}/packages/{package_type}/{package_name}": { - "get": { - "summary": "Get a package for an organization", - "description": "Gets a specific package in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", - "tags": [ - "packages" - ], - "operationId": "packages/get-package-for-organization", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization" - }, - "parameters": [ - { - "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 (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", - "in": "path", - "required": true, - "schema": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - } - }, - { - "name": "package_name", - "description": "The name of the package.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "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": "Package", - "description": "A software package", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the package.", - "type": "integer", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the package.", - "type": "string", - "examples": [ - "super-linter" - ] - }, - "package_type": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ], - "examples": [ - "docker" - ] - }, - "url": { - "type": "string", "examples": [ - "https://api.github.com/orgs/github/packages/container/super-linter" + "ent:team-one", + "ent:team-two" ] }, - "html_url": { + "organization_url": { "type": "string", + "format": "uri", "examples": [ - "https://github.com/orgs/github/packages/container/package/super-linter" - ] - }, - "version_count": { - "description": "The number of versions of the package.", - "type": "integer", - "examples": [ - 1 + "https://api.github.com/orgs/octocat" ] }, - "visibility": { - "type": "string", - "enum": [ - "private", - "public" - ], - "examples": [ - "private" + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" ] }, - "owner": { + "user": { "anyOf": [ { "type": "null" @@ -131683,21 +124625,583 @@ } ] }, - "repository": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Minimal Repository", - "description": "Minimal Repository", + "permissions": { + "type": "object", + "properties": { + "can_create_repository": { + "type": "boolean" + } + }, + "required": [ + "can_create_repository" + ] + } + }, + "required": [ + "state", + "role", + "organization_url", + "url", + "organization", + "user" + ] + }, + "examples": { + "response-if-user-already-had-membership-with-organization": { + "summary": "Response if user has an active admin membership with organization", + "value": { + "url": "https://api.github.com/orgs/octocat/memberships/defunkt", + "state": "active", + "role": "admin", + "organization_url": "https://api.github.com/orgs/octocat", + "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" + }, + "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 + } + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "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": "members" + } + }, + "delete": { + "summary": "Remove organization membership for a user", + "description": "In order to remove a user's membership with an organization, the authenticated user must be an organization owner.\n\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.\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-membership-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/members#remove-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" + } + }, + { + "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": { + "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": "members" + } + } + }, + "/orgs/{org}/migrations": { + "get": { + "summary": "List organization migrations", + "description": "Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API).\n\nA list of `repositories` is only returned for export migrations.", + "tags": [ + "migrations" + ], + "operationId": "migrations/list-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/migrations/orgs#list-organization-migrations" + }, + "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": "exclude", + "description": "Exclude attributes from the API response to improve performance", + "in": "query", + "schema": { + "type": "array", + "items": { + "description": "Allowed values that can be passed to the exclude param.", + "enum": [ + "repositories" + ], + "type": "string", + "examples": [ + "repositories" + ] + } + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Migration", + "description": "A migration.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 79 + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "guid": { + "type": "string", + "examples": [ + "0b989ba4-242f-11e5-81e1-c7b6966d2516" + ] + }, + "state": { + "type": "string", + "examples": [ + "pending" + ] + }, + "lock_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "exclude_metadata": { + "type": "boolean" + }, + "exclude_git_data": { + "type": "boolean" + }, + "exclude_attachments": { + "type": "boolean" + }, + "exclude_releases": { + "type": "boolean" + }, + "exclude_owner_projects": { + "type": "boolean" + }, + "org_metadata_only": { + "type": "boolean" + }, + "repositories": { + "type": "array", + "description": "The repositories included in the migration. Only returned for export migrations.", + "items": { + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", "properties": { "id": { + "description": "Unique identifier of the repository", "type": "integer", "format": "int64", "examples": [ - 1296269 + 42 ] }, "node_id": { @@ -131707,9 +125211,10 @@ ] }, "name": { + "description": "The name of the repository.", "type": "string", "examples": [ - "Hello-World" + "Team Environment" ] }, "full_name": { @@ -131718,27 +125223,117 @@ "octocat/Hello-World" ] }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] + "admin": { + "type": "boolean" }, - "email": { - "type": [ - "string", - "null" - ] + "pull": { + "type": "boolean" }, - "login": { - "type": "string", - "examples": [ - "octocat" + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" ] }, "id": { @@ -131887,6 +125482,8 @@ ] }, "private": { + "description": "Whether the repository is private or public.", + "default": false, "type": "boolean" }, "html_url": { @@ -132023,7 +125620,10 @@ ] }, "git_url": { - "type": "string" + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] }, "issue_comment_url": { "type": "string", @@ -132094,7 +125694,10 @@ ] }, "ssh_url": { - "type": "string" + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] }, "stargazers_url": { "type": "string", @@ -132144,12 +125747,19 @@ ] }, "clone_url": { - "type": "string" + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] }, "mirror_url": { "type": [ "string", "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { @@ -132160,12 +125770,20 @@ ] }, "svn_url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] }, "homepage": { "type": [ "string", "null" + ], + "format": "uri", + "examples": [ + "https://github.com" ] }, "language": { @@ -132175,26 +125793,50 @@ ] }, "forks_count": { - "type": "integer" + "type": "integer", + "examples": [ + 9 + ] }, "stargazers_count": { - "type": "integer" + "type": "integer", + "examples": [ + 80 + ] }, "watchers_count": { - "type": "integer" + "type": "integer", + "examples": [ + 80 + ] }, "size": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" + "type": "integer", + "examples": [ + 108 + ] }, "default_branch": { - "type": "string" + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] }, "open_issues_count": { - "type": "integer" + "type": "integer", + "examples": [ + 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", + "examples": [ + true + ] }, "topics": { "type": "array", @@ -132203,30 +125845,61 @@ } }, "has_issues": { - "type": "boolean" + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_projects": { - "type": "boolean" + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_wiki": { - "type": "boolean" + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_pages": { "type": "boolean" }, "has_downloads": { - "type": "boolean" + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] }, "has_discussions": { - "type": "boolean" + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] }, "archived": { + "description": "Whether the repository is archived.", + "default": false, "type": "boolean" }, "disabled": { - "type": "boolean" + "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": { @@ -132259,238 +125932,136 @@ "2011-01-26T19:14:43Z" ] }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", "examples": [ - "admin" + true ] }, "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", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# 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", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true ] }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - } + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] }, - "forks": { - "type": "integer", + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", "examples": [ - 0 + false ] }, - "open_issues": { - "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", "examples": [ - 0 + false ] }, - "watchers": { - "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 + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", "examples": [ - 0 + true ] }, "allow_forking": { + "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { - "type": "boolean", + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", "examples": [ - false + "\"2020-07-09T00:17:42Z\"" ] }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], + "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": { - "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": [ @@ -132539,580 +126110,89 @@ "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" ] } - ] - }, - "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" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "packages", - "subcategory": "packages" - } - }, - "delete": { - "summary": "Delete a package for an organization", - "description": "Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", - "tags": [ - "packages" - ], - "operationId": "packages/delete-package-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization" - }, - "parameters": [ - { - "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 (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", - "in": "path", - "required": true, - "schema": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - } - }, - { - "name": "package_name", - "description": "The name of the package.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "404": { - "description": "Resource not found", - "content": { - "application/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" - } - } - } - } - } - }, - "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}/packages/{package_type}/{package_name}/restore": { - "post": { - "summary": "Restore a package for an organization", - "description": "Restores an entire package in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", - "tags": [ - "packages" - ], - "operationId": "packages/restore-package-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization" - }, - "parameters": [ - { - "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 (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", - "in": "path", - "required": true, - "schema": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - } - }, - { - "name": "package_name", - "description": "The name of the package.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "token", - "description": "package token", - "schema": { - "type": "string" - }, - "required": false, - "in": "query" - } - ], - "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" - } - } - } - } - } - }, - "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}/packages/{package_type}/{package_name}/versions": { - "get": { - "summary": "List package versions for a package owned by an organization", - "description": "Lists package versions for a package owned by an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", - "tags": [ - "packages" - ], - "operationId": "packages/get-all-package-versions-for-package-owned-by-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization" - }, - "parameters": [ - { - "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 (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", - "in": "path", - "required": true, - "schema": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - } - }, - { - "name": "package_name", - "description": "The name of the package.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "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": 30 - } - }, - { - "name": "state", - "in": "query", - "required": false, - "description": "The state of the package, either active or deleted.", - "schema": { - "type": "string", - "enum": [ - "active", - "deleted" - ], - "default": "active" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Package Version", - "description": "A version of a software package", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the package version.", - "type": "integer", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the package version.", - "type": "string", - "examples": [ - "latest" - ] }, "url": { "type": "string", + "format": "uri", "examples": [ - "https://api.github.com/orgs/github/packages/container/super-linter/versions/786068" - ] - }, - "package_html_url": { - "type": "string", - "examples": [ - "https://github.com/orgs/github/packages/container/package/super-linter" - ] - }, - "html_url": { - "type": "string", - "examples": [ - "https://github.com/orgs/github/packages/container/super-linter/786068" - ] - }, - "license": { - "type": "string", - "examples": [ - "MIT" + "https://api.github.com/orgs/octo-org/migrations/79" ] }, - "description": { - "type": "string" - }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2011-04-10T20:09:31Z" + "2015-07-06T15:33:38-07:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2014-03-03T18:58:10Z" + "2015-07-06T15:33:38-07:00" ] }, - "deleted_at": { + "node_id": { + "type": "string" + }, + "archive_url": { "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] + "format": "uri" }, - "metadata": { - "type": "object", - "title": "Package Version Metadata", - "properties": { - "package_type": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ], - "examples": [ - "docker" - ] - }, - "container": { - "type": "object", - "title": "Container Metadata", - "properties": { - "tags": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "tags" - ] - }, - "docker": { - "type": "object", - "title": "Docker Metadata", - "properties": { - "tag": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "tags" - ] - } - }, - "required": [ - "package_type" - ] + "exclude": { + "description": "Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `\"repositories\"`.", + "type": "array", + "items": { + "description": "Allowed values that can be passed to the exclude parameter. The array can include any of: `\"repositories\"`.", + "type": "string" + } } }, "required": [ "id", - "name", + "node_id", + "owner", + "guid", + "state", + "lock_repositories", + "exclude_metadata", + "exclude_git_data", + "exclude_attachments", + "exclude_releases", + "exclude_owner_projects", + "org_metadata_only", + "repositories", "url", - "package_html_url", "created_at", "updated_at" ] @@ -133122,109 +126202,173 @@ "default": { "value": [ { - "id": 245301, - "name": "1.0.4", - "url": "https://api.github.com/orgs/octo-org/packages/npm/hello-world-npm/versions/245301", - "package_html_url": "https://github.com/octo-org/hello-world-npm/packages/43752", - "created_at": "2019-11-05T22:49:04Z", - "updated_at": "2019-11-05T22:49:04Z", - "html_url": "https://github.com/octo-org/hello-world-npm/packages/43752?version=1.0.4", - "metadata": { - "package_type": "npm" - } - }, - { - "id": 209672, - "name": "1.0.3", - "url": "https://api.github.com/orgs/octo-org/packages/npm/hello-world-npm/versions/209672", - "package_html_url": "https://github.com/octo-org/hello-world-npm/packages/43752", - "created_at": "2019-10-29T15:42:11Z", - "updated_at": "2019-10-29T15:42:12Z", - "html_url": "https://github.com/octo-org/hello-world-npm/packages/43752?version=1.0.3", - "metadata": { - "package_type": "npm" - } + "id": 79, + "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 + }, + "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "state": "pending", + "lock_repositories": true, + "exclude_attachments": false, + "exclude_releases": false, + "exclude_owner_projects": false, + "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://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + ], + "url": "https://api.github.com/orgs/octo-org/migrations/79", + "created_at": "2015-07-06T15:33:38-07:00", + "updated_at": "2015-07-06T15:33:38-07:00", + "node_id": "MDQ6VXNlcjE=" } ] } } } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/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" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "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" } } } @@ -133233,50 +126377,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "category": "packages", - "subcategory": "packages" + "category": "migrations", + "subcategory": "orgs" } - } - }, - "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}": { - "get": { - "summary": "Get a package version for an organization", - "description": "Gets a specific package version in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + }, + "post": { + "summary": "Start an organization migration", + "description": "Initiates the generation of a migration archive.", "tags": [ - "packages" + "migrations" ], - "operationId": "packages/get-package-version-for-organization", + "operationId": "migrations/start-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization" + "url": "https://docs.github.com/rest/migrations/orgs#start-an-organization-migration" }, "parameters": [ - { - "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 (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", - "in": "path", - "required": true, - "schema": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - } - }, - { - "name": "package_name", - "description": "The name of the package.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, { "name": "org", "description": "The organization name. The name is not case sensitive.", @@ -133285,1446 +126401,1504 @@ "schema": { "type": "string" } - }, - { - "name": "package_version_id", - "description": "Unique identifier of the package version.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "repositories": { + "type": "array", + "description": "A list of arrays indicating which repositories should be migrated.", + "items": { + "type": "string" + } + }, + "lock_repositories": { + "type": "boolean", + "description": "Indicates whether repositories should be locked (to prevent manipulation) while migrating data.", + "default": false, + "examples": [ + true + ] + }, + "exclude_metadata": { + "type": "boolean", + "description": "Indicates whether metadata should be excluded and only git source should be included for the migration.", + "default": false + }, + "exclude_git_data": { + "type": "boolean", + "description": "Indicates whether the repository git data should be excluded from the migration.", + "default": false + }, + "exclude_attachments": { + "type": "boolean", + "description": "Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).", + "default": false, + "examples": [ + true + ] + }, + "exclude_releases": { + "type": "boolean", + "description": "Indicates whether releases should be excluded from the migration (to reduce migration archive file size).", + "default": false, + "examples": [ + true + ] + }, + "exclude_owner_projects": { + "type": "boolean", + "description": "Indicates whether projects owned by the organization or users should be excluded. from the migration.", + "default": false, + "examples": [ + true + ] + }, + "org_metadata_only": { + "type": "boolean", + "description": "Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).", + "default": false, + "examples": [ + true + ] + }, + "exclude": { + "type": "array", + "description": "Exclude related items from being returned in the response in order to improve performance of the request.", + "items": { + "type": "string", + "enum": [ + "repositories" + ] + } + } + }, + "required": [ + "repositories" + ] + }, + "examples": { + "default": { + "value": { + "repositories": [ + "github/Hello-World" + ], + "lock_repositories": true + } + } + } + } + } + }, "responses": { - "200": { + "201": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Package Version", - "description": "A version of a software package", + "title": "Migration", + "description": "A migration.", "type": "object", "properties": { "id": { - "description": "Unique identifier of the package version.", "type": "integer", + "format": "int64", "examples": [ - 1 + 79 ] }, - "name": { - "description": "The name of the package version.", - "type": "string", - "examples": [ - "latest" + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } ] }, - "url": { + "guid": { "type": "string", "examples": [ - "https://api.github.com/orgs/github/packages/container/super-linter/versions/786068" + "0b989ba4-242f-11e5-81e1-c7b6966d2516" ] }, - "package_html_url": { + "state": { "type": "string", "examples": [ - "https://github.com/orgs/github/packages/container/package/super-linter" + "pending" ] }, - "html_url": { - "type": "string", + "lock_repositories": { + "type": "boolean", "examples": [ - "https://github.com/orgs/github/packages/container/super-linter/786068" + true ] }, - "license": { - "type": "string", - "examples": [ - "MIT" - ] + "exclude_metadata": { + "type": "boolean" }, - "description": { - "type": "string" + "exclude_git_data": { + "type": "boolean" }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] + "exclude_attachments": { + "type": "boolean" }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] + "exclude_releases": { + "type": "boolean" }, - "deleted_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] + "exclude_owner_projects": { + "type": "boolean" }, - "metadata": { - "type": "object", - "title": "Package Version Metadata", - "properties": { - "package_type": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ], - "examples": [ - "docker" - ] - }, - "container": { - "type": "object", - "title": "Container Metadata", - "properties": { - "tags": { - "type": "array", - "items": { - "type": "string" + "org_metadata_only": { + "type": "boolean" + }, + "repositories": { + "type": "array", + "description": "The repositories included in the migration. Only returned for export migrations.", + "items": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] } - } + ] }, - "required": [ - "tags" - ] - }, - "docker": { - "type": "object", - "title": "Docker Metadata", - "properties": { - "tag": { - "type": "array", - "items": { - "type": "string" + "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" + ] }, - "required": [ - "tags" - ] - } - }, - "required": [ - "package_type" - ] - } - }, - "required": [ - "id", - "name", - "url", - "package_html_url", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 836, - "name": "sha256:b3d3e366b55f9a54599220198b3db5da8f53592acbbb7dc7e4e9878762fc5344", - "url": "https://api.github.com/orgs/github/packages/container/hello_docker/versions/836", - "package_html_url": "https://github.com/orgs/github/packages/container/package/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/hello_docker/836", - "metadata": { - "package_type": "container", - "container": { - "tags": [ - "latest" - ] - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "packages", - "subcategory": "packages" - } - }, - "delete": { - "summary": "Delete package version for an organization", - "description": "Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", - "tags": [ - "packages" - ], - "operationId": "packages/delete-package-version-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization" - }, - "parameters": [ - { - "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 (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", - "in": "path", - "required": true, - "schema": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - } - }, - { - "name": "package_name", - "description": "The name of the package.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "package_version_id", - "description": "Unique identifier of the package version.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "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" - } - } - } - } - } - }, - "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}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { - "post": { - "summary": "Restore package version for an organization", - "description": "Restores a specific package version in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", - "tags": [ - "packages" - ], - "operationId": "packages/restore-package-version-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization" - }, - "parameters": [ - { - "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 (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", - "in": "path", - "required": true, - "schema": { - "type": "string", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - } - }, - { - "name": "package_name", - "description": "The name of the package.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "package_version_id", - "description": "Unique identifier of the package version.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "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" - } - } - } - } - } - }, - "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}/personal-access-token-requests": { - "get": { - "summary": "List requests to access organization resources with fine-grained personal access tokens", - "description": "Lists requests from organization members to access organization resources with a fine-grained personal access token.\n\nOnly GitHub Apps can use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/list-pat-grant-requests", - "externalDocs": { - "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": [ - { - "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": "sort", - "description": "The property by which to sort the results.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created_at" - ], - "default": "created_at" - } - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "owner", - "description": "A list of owner usernames to use to filter the results.", - "in": "query", - "required": false, - "schema": { - "type": "array", - "maxItems": 10, - "items": { - "type": "string" - }, - "examples": [ - "owner[]=octocat1,owner[]=octocat2" - ] - } - }, - { - "name": "repository", - "description": "The name of the repository to use to filter the results.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "examples": [ - "Hello-World" - ] - } - }, - { - "name": "permission", - "description": "The permission to use to filter the results.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "examples": [ - "issues_read" - ] - } - }, - { - "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) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "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) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "token_id", - "description": "The ID of the token", - "in": "query", - "required": false, - "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "examples": [ - "token_id[]=1,token_id[]=2" - ] - } - } - ], - "responses": { - "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" - } - } - } - } - } - }, - "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": [ - { + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { "type": [ "string", "null" ] }, - { + "email": { "type": [ - "integer", + "string", "null" ] }, - { + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { "type": [ - "array", + "string", "null" ], - "items": { - "type": "string" - } + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] - } - } - } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/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" - } - } - } - } - } - }, - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Simple Organization Programmatic Access Grant Request", - "description": "Minimal representation of an organization programmatic access grant request for enumerations", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the request for access via fine-grained personal access token. The `pat_request_id` used to review PAT requests." - }, - "reason": { - "type": [ - "string", - "null" - ], - "description": "Reason for requesting access." - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" ] }, - "email": { + "description": { "type": [ "string", "null" + ], + "examples": [ + "This your first repo!" ] }, - "login": { + "fork": { + "type": "boolean" + }, + "url": { "type": "string", + "format": "uri", "examples": [ - "octocat" + "https://api.github.com/repos/octocat/Hello-World" ] }, - "id": { - "type": "integer", - "format": "int64", + "archive_url": { + "type": "string", "examples": [ - 1 + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, - "node_id": { + "assignees_url": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, - "avatar_url": { + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, - "gravatar_id": { - "type": [ - "string", - "null" - ], + "deployments_url": { + "type": "string", + "format": "uri", "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, - "url": { + "downloads_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, - "html_url": { + "events_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat" + "http://api.github.com/repos/octocat/Hello-World/events" ] }, - "followers_url": { + "forks_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "http://api.github.com/repos/octocat/Hello-World/forks" ] }, - "following_url": { + "git_commits_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, - "gists_url": { + "git_refs_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, - "starred_url": { + "git_tags_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, - "subscriptions_url": { + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "http://api.github.com/repos/octocat/Hello-World/languages" ] }, - "organizations_url": { + "merges_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "http://api.github.com/repos/octocat/Hello-World/merges" ] }, - "repos_url": { + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, - "events_url": { + "statuses_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, - "received_events_url": { + "subscribers_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, - "type": { + "subscription_url": { "type": "string", + "format": "uri", "examples": [ - "User" + "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, - "site_admin": { - "type": "boolean" + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] }, - "starred_at": { + "teams_url": { "type": "string", + "format": "uri", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "http://api.github.com/repos/octocat/Hello-World/teams" ] }, - "user_view_type": { + "trees_url": { "type": "string", "examples": [ - "public" + "http://api.github.com/repos/octocat/Hello-World/git/trees{/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" - ] - }, - "repository_selection": { - "type": "string", - "enum": [ - "none", - "all", - "subset" - ], - "description": "Type of repository selection requested." - }, - "repositories_url": { - "type": "string", - "description": "URL to the list of repositories requested to be accessed via fine-grained personal access token. Should only be followed when `repository_selection` is `subset`." - }, - "permissions": { - "type": "object", - "description": "Permissions requested, categorized by type of permission.", - "properties": { - "organization": { - "type": "object", - "additionalProperties": { - "type": "string" - } }, - "repository": { - "type": "object", - "additionalProperties": { - "type": "string" - } + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] }, - "other": { - "type": "object", - "additionalProperties": { + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { "type": "string" } - } - } - }, - "created_at": { - "type": "string", - "description": "Date and time when the request for access was created." - }, - "token_id": { - "type": "integer", - "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." - }, - "token_name": { - "type": "string", - "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." - }, - "token_expired": { - "type": "boolean", - "description": "Whether the associated fine-grained personal access token has expired." - }, - "token_expires_at": { - "type": [ - "string", - "null" - ], - "description": "Date and time when the associated fine-grained personal access token expires." - }, - "token_last_used_at": { - "type": [ - "string", - "null" - ], - "description": "Date and time when the associated fine-grained personal access token was last used for authentication." - } - }, - "required": [ - "id", - "reason", - "owner", - "repository_selection", - "repositories_url", - "permissions", - "created_at", - "token_id", - "token_name", - "token_expired", - "token_expires_at", - "token_last_used_at" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 25381, - "reason": "I need to access the GitHub API", - "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_selection": "all", - "repositories_url": "https://api.github.com/organizations/652551/personal-access-token-requests/25381/repositories", - "permissions": { - "organization": { - "members": "read" }, - "repository": { - "metadata": "read" - } - }, - "created_at": "2023-05-16T08:47:09.000-07:00", - "token_id": 98716, - "token_name": "Some Token", - "token_expired": false, - "token_expires_at": "2023-11-16T08:47:09.000-07:00", - "token_last_used_at": null - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "personal-access-tokens" - } - }, - "post": { - "summary": "Review requests to access organization resources with fine-grained personal access tokens", - "description": "Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token.\n\nOnly GitHub Apps can use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/review-pat-grant-requests-in-bulk", - "externalDocs": { - "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": [ - { - "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": { - "pat_request_ids": { - "type": "array", - "description": "Unique identifiers of the requests for access via fine-grained personal access token. Must be formed of between 1 and 100 `pat_request_id` values.", - "items": { - "type": "integer" - }, - "minItems": 1, - "maxItems": 100 - }, - "action": { - "type": "string", - "description": "Action to apply to the requests.", - "enum": [ - "approve", - "deny" - ] - }, - "reason": { - "type": [ - "string", - "null" - ], - "description": "Reason for approving or denying the requests. Max 1024 characters.", - "maxLength": 1024 - } - }, - "required": [ - "action" - ] - }, - "examples": { - "204": { - "summary": "Example of denying a request", - "value": { - "pat_request_ids": [ - 42, - 73 - ], - "action": "deny", - "reason": "Access is too broad." - } - } - } - } - } - }, - "responses": { - "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" - } - } - } - } - } - }, - "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" + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, - "field": { - "type": "string" + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, - "message": { + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", "type": "string" }, - "code": { + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { "type": "string" }, - "index": { + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { "type": "integer" }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } + "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" + ] } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" }, "url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octo-org/migrations/79" + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2015-07-06T15:33:38-07:00" + ] }, - "documentation_url": { - "type": "string" + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2015-07-06T15:33:38-07:00" + ] }, - "url": { + "node_id": { "type": "string" }, - "status": { - "type": "string" + "archive_url": { + "type": "string", + "format": "uri" + }, + "exclude": { + "description": "Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `\"repositories\"`.", + "type": "array", + "items": { + "description": "Allowed values that can be passed to the exclude parameter. The array can include any of: `\"repositories\"`.", + "type": "string" + } } - } - } - } - } - }, - "202": { - "description": "Accepted", - "content": { - "application/json": { - "schema": { - "type": "object" + }, + "required": [ + "id", + "node_id", + "owner", + "guid", + "state", + "lock_repositories", + "exclude_metadata", + "exclude_git_data", + "exclude_attachments", + "exclude_releases", + "exclude_owner_projects", + "org_metadata_only", + "repositories", + "url", + "created_at", + "updated_at" + ] }, "examples": { "default": { - "value": null + "value": { + "id": 79, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "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 + }, + "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "state": "pending", + "lock_repositories": true, + "exclude_attachments": false, + "exclude_releases": false, + "exclude_owner_projects": false, + "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://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + ], + "url": "https://api.github.com/orgs/octo-org/migrations/79", + "created_at": "2015-07-06T15:33:38-07:00", + "updated_at": "2015-07-06T15:33:38-07:00" + } } } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "personal-access-tokens" - } - } - }, - "/orgs/{org}/personal-access-token-requests/{pat_request_id}": { - "post": { - "summary": "Review a request to access organization resources with a fine-grained personal access token", - "description": "Approves or denies a pending request to access organization resources via a fine-grained personal access token.\n\nOnly GitHub Apps can use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/review-pat-grant-request", - "externalDocs": { - "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": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } }, - { - "name": "pat_request_id", - "in": "path", - "description": "Unique identifier of the request for access via fine-grained personal access token.", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "action": { - "type": "string", - "description": "Action to apply to the request.", - "enum": [ - "approve", - "deny" - ] - }, - "reason": { - "type": [ - "string", - "null" - ], - "description": "Reason for approving or denying the request. Max 1024 characters.", - "maxLength": 1024 - } - }, - "required": [ - "action" - ] - }, - "examples": { - "204": { - "summary": "Example of denying a request", - "value": { - "action": "deny", - "reason": "This request is denied because the access is too broad." - } - } - } - } - } - }, - "responses": { - "500": { - "description": "Internal Error", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -134823,82 +127997,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" - } - } - } - } - } - }, - "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" - } - } - } - } - } - }, - "204": { - "description": "A header with no content is returned." } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "personal-access-tokens" + "enabledForGitHubApps": false, + "category": "migrations", + "subcategory": "orgs" } } }, - "/orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories": { + "/orgs/{org}/migrations/{migration_id}": { "get": { - "summary": "List repositories requested to be accessed by a fine-grained personal access token", - "description": "Lists the repositories a fine-grained personal access token request is requesting access to.\n\nOnly GitHub Apps can use this endpoint.", + "summary": "Get an organization migration status", + "description": "Fetches the status of a migration.\n\nThe `state` of a migration can be one of the following values:\n\n* `pending`, which means the migration hasn't started yet.\n* `exporting`, which means the migration is in progress.\n* `exported`, which means the migration finished successfully.\n* `failed`, which means the migration failed.", "tags": [ - "orgs" + "migrations" ], - "operationId": "orgs/list-pat-grant-request-repositories", + "operationId": "migrations/get-status-for-org", "externalDocs": { "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" + "url": "https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status" }, "parameters": [ { @@ -134911,69 +128030,1515 @@ } }, { - "name": "pat_request_id", + "name": "migration_id", + "description": "The unique identifier of the migration.", "in": "path", - "description": "Unique identifier of the request for access via fine-grained personal access token.", "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).\"", + "name": "exclude", + "description": "Exclude attributes from the API response to improve performance", "in": "query", "schema": { - "type": "integer", - "default": 1 + "type": "array", + "items": { + "description": "Allowed values that can be passed to the exclude param.", + "enum": [ + "repositories" + ], + "type": "string", + "examples": [ + "repositories" + ] + } } } ], "responses": { - "500": { - "description": "Internal Error", + "200": { + "description": "* `pending`, which means the migration hasn't started yet.\n* `exporting`, which means the migration is in progress.\n* `exported`, which means the migration finished successfully.\n* `failed`, which means the migration failed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Migration", + "description": "A migration.", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 79 + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "guid": { + "type": "string", + "examples": [ + "0b989ba4-242f-11e5-81e1-c7b6966d2516" + ] + }, + "state": { + "type": "string", + "examples": [ + "pending" + ] + }, + "lock_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "exclude_metadata": { + "type": "boolean" + }, + "exclude_git_data": { + "type": "boolean" + }, + "exclude_attachments": { + "type": "boolean" + }, + "exclude_releases": { + "type": "boolean" + }, + "exclude_owner_projects": { + "type": "boolean" + }, + "org_metadata_only": { + "type": "boolean" + }, + "repositories": { + "type": "array", + "description": "The repositories included in the migration. Only returned for export migrations.", + "items": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + } + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/octo-org/migrations/79" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2015-07-06T15:33:38-07:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2015-07-06T15:33:38-07:00" + ] + }, + "node_id": { + "type": "string" + }, + "archive_url": { + "type": "string", + "format": "uri" + }, + "exclude": { + "description": "Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `\"repositories\"`.", + "type": "array", + "items": { + "description": "Allowed values that can be passed to the exclude parameter. The array can include any of: `\"repositories\"`.", + "type": "string" + } + } + }, + "required": [ + "id", + "node_id", + "owner", + "guid", + "state", + "lock_repositories", + "exclude_metadata", + "exclude_git_data", + "exclude_attachments", + "exclude_releases", + "exclude_owner_projects", + "org_metadata_only", + "repositories", + "url", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 79, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "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 + }, + "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "state": "exported", + "lock_repositories": true, + "exclude_attachments": false, + "exclude_releases": false, + "exclude_owner_projects": false, + "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://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + ], + "url": "https://api.github.com/orgs/octo-org/migrations/79", + "created_at": "2015-07-06T15:33:38-07:00", + "updated_at": "2015-07-06T15:33:38-07:00" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/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": "migrations", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/migrations/{migration_id}/archive": { + "get": { + "summary": "Download an organization migration archive", + "description": "Fetches the URL to a migration archive.", + "tags": [ + "migrations" + ], + "operationId": "migrations/download-archive-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "migration_id", + "description": "The unique identifier of the migration.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "302": { + "description": "Response" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { "message": { "type": "string" }, @@ -134990,9 +129555,132 @@ } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "migrations", + "subcategory": "orgs" + } + }, + "delete": { + "summary": "Delete an organization migration archive", + "description": "Deletes a previous migration archive. Migration archives are automatically deleted after seven days.", + "tags": [ + "migrations" + ], + "operationId": "migrations/delete-archive-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "403": { - "description": "Forbidden", + { + "name": "migration_id", + "description": "The unique identifier of the migration.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "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": false, + "category": "migrations", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock": { + "delete": { + "summary": "Unlock an organization repository", + "description": "Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data.", + "tags": [ + "migrations" + ], + "operationId": "migrations/unlock-repo-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "migration_id", + "description": "The unique identifier of the migration.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "repo_name", + "description": "repo_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -135016,7 +129704,67 @@ } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "migrations", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/migrations/{migration_id}/repositories": { + "get": { + "summary": "List repositories in an organization migration", + "description": "List all the repositories for this organization migration.", + "tags": [ + "migrations" + ], + "operationId": "migrations/list-repos-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "migration_id", + "description": "The unique identifier of the migration.", + "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": { @@ -136012,27 +130760,53 @@ } } } + }, + "404": { + "description": "Resource not found", + "content": { + "application/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": "personal-access-tokens" + "enabledForGitHubApps": false, + "category": "migrations", + "subcategory": "orgs" } } }, - "/orgs/{org}/personal-access-tokens": { + "/orgs/{org}/organization-roles": { "get": { - "summary": "List fine-grained personal access tokens with access to organization resources", - "description": "Lists approved fine-grained personal access tokens owned by organization members that can access organization resources.\n\nOnly GitHub Apps can use this endpoint.", + "summary": "Get all organization roles for an organization", + "description": "Lists the organization roles available in this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], - "operationId": "orgs/list-pat-grants", + "operationId": "orgs/list-org-roles", "externalDocs": { "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" + "url": "https://docs.github.com/rest/orgs/organization-roles#get-all-organization-roles-for-an-organization" }, "parameters": [ { @@ -136043,701 +130817,346 @@ "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": "sort", - "description": "The property by which to sort the results.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created_at" - ], - "default": "created_at" - } - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "owner", - "description": "A list of owner usernames to use to filter the results.", - "in": "query", - "required": false, - "schema": { - "type": "array", - "maxItems": 10, - "items": { - "type": "string" - }, - "examples": [ - "owner[]=octocat1,owner[]=octocat2" - ] - } - }, - { - "name": "repository", - "description": "The name of the repository to use to filter the results.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "examples": [ - "Hello-World" - ] - } - }, - { - "name": "permission", - "description": "The permission to use to filter the results.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "examples": [ - "issues_read" - ] - } - }, - { - "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) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "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) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "token_id", - "description": "The ID of the token", - "in": "query", - "required": false, - "schema": { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - }, - "examples": [ - "token_id[]=1,token_id[]=2" - ] - } } ], "responses": { - "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" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + "200": { + "description": "Response - list of organization roles", "content": { "application/json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + "total_count": { + "type": "integer", + "description": "The total number of organization roles available to the organization." }, - "errors": { + "roles": { "type": "array", + "description": "The list of organization roles available to the organization.", "items": { + "title": "Organization Role", + "description": "Organization roles", "type": "object", - "required": [ - "code" - ], "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" + "id": { + "description": "The unique identifier of the role.", + "type": "integer", + "format": "int64" }, - "code": { + "name": { + "description": "The name of the role.", "type": "string" }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "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" - } - } - } - } - } - }, - "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" - } - } - } - } - } - }, - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Organization Programmatic Access Grant", - "description": "Minimal representation of an organization programmatic access grant for enumerations", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the fine-grained personal access token grant. The `pat_id` used to get details about an approved fine-grained personal access token." - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { + "description": { + "description": "A short description about who this role is for or what permissions it grants.", "type": [ "string", "null" ] }, - "email": { + "base_role": { "type": [ "string", "null" + ], + "description": "The system role from which this role inherits permissions.", + "enum": [ + "read", + "triage", + "write", + "maintain", + "admin", + null ] }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { + "source": { "type": [ "string", "null" ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" + "description": "Source answers the question, \"where did this role come from?\"", + "enum": [ + "Organization", + "Enterprise", + "Predefined", + null ] }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] + "permissions": { + "description": "A list of permissions included in this role.", + "type": "array", + "items": { + "type": "string" + } }, - "type": { - "type": "string", - "examples": [ - "User" + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { + "created_at": { + "description": "The date and time the role was created.", "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "format": "date-time" }, - "user_view_type": { + "updated_at": { + "description": "The date and time the role was last updated.", "type": "string", - "examples": [ - "public" - ] + "format": "date-time" } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "name", + "permissions", + "organization", + "created_at", + "updated_at" ] - }, - "repository_selection": { - "type": "string", - "enum": [ - "none", - "all", - "subset" - ], - "description": "Type of repository selection requested." - }, - "repositories_url": { - "type": "string", - "description": "URL to the list of repositories the fine-grained personal access token can access. Only follow when `repository_selection` is `subset`." - }, - "permissions": { - "type": "object", - "description": "Permissions requested, categorized by type of permission.", - "properties": { - "organization": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "repository": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "other": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, - "access_granted_at": { - "type": "string", - "description": "Date and time when the fine-grained personal access token was approved to access the organization." - }, - "token_id": { - "type": "integer", - "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." - }, - "token_name": { - "type": "string", - "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." - }, - "token_expired": { - "type": "boolean", - "description": "Whether the associated fine-grained personal access token has expired." - }, - "token_expires_at": { - "type": [ - "string", - "null" - ], - "description": "Date and time when the associated fine-grained personal access token expires." - }, - "token_last_used_at": { - "type": [ - "string", - "null" - ], - "description": "Date and time when the associated fine-grained personal access token was last used for authentication." } - }, - "required": [ - "id", - "owner", - "repository_selection", - "repositories_url", - "permissions", - "access_granted_at", - "token_id", - "token_name", - "token_expired", - "token_expires_at", - "token_last_used_at" - ] + } } }, "examples": { "default": { - "value": [ - { - "id": 25381, - "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_selection": "all", - "repositories_url": "https://api.github.com/organizations/652551/personal-access-tokens/25381/repositories", - "permissions": { + "value": { + "total_count": 2, + "roles": [ + { + "id": 8030, + "name": "Custom Role Manager", + "description": "Permissions to manage custom roles within an org", + "permissions": [ + "write_organization_custom_repo_role", + "write_organization_custom_org_role", + "read_organization_custom_repo_role", + "read_organization_custom_org_role" + ], "organization": { - "members": "read" + "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 }, - "repository": { - "metadata": "read" - } + "created_at": "2022-07-04T22:19:11Z", + "updated_at": "2022-07-04T22:20:11Z" }, - "access_granted_at": "2023-05-16T08:47:09.000-07:00", - "token_id": 98716, - "token_name": "Some Token", - "token_expired": false, - "token_expires_at": "2023-11-16T08:47:09.000-07:00", - "token_last_used_at": null - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "personal-access-tokens" - } - }, - "post": { - "summary": "Update the access to organization resources via fine-grained personal access tokens", - "description": "Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access.\n\nOnly GitHub Apps can use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/update-pat-accesses", - "externalDocs": { - "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": [ - { - "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": { - "action": { - "type": "string", - "description": "Action to apply to the fine-grained personal access token.", - "enum": [ - "revoke" - ] - }, - "pat_ids": { - "description": "The IDs of the fine-grained personal access tokens.", - "type": "array", - "items": { - "type": "integer", - "description": "Unique identifier of the fine-grained personal access token." - }, - "minItems": 1, - "maxItems": 100 - } - }, - "required": [ - "action", - "pat_ids" - ] - }, - "examples": { - "204": { - "summary": "Example of revoking a fine-grained personal access token.", - "value": { - "action": "revoke", - "pat_ids": [ - 1296269, - 1296280 - ] - } - } - } - } - } - }, - "responses": { - "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" + { + "id": 8031, + "name": "Auditor", + "description": "Permissions to read the organization audit log", + "permissions": [ + "read_audit_logs" + ], + "organization": { + "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 + }, + "created_at": "2022-07-04T22:19:11Z", + "updated_at": "2022-07-04T22:20:11Z" + } + ] } } } @@ -136770,47 +131189,6 @@ } } }, - "202": { - "description": "Accepted", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "default": { - "value": null - } - } - } - } - }, - "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" - } - } - } - } - } - }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { @@ -136891,21 +131269,21 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", - "subcategory": "personal-access-tokens" + "subcategory": "organization-roles" } } }, - "/orgs/{org}/personal-access-tokens/{pat_id}": { - "post": { - "summary": "Update the access a fine-grained personal access token has to organization resources", - "description": "Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access.\n\nOnly GitHub Apps can use this endpoint.", + "/orgs/{org}/organization-roles/teams/{team_slug}": { + "delete": { + "summary": "Remove all organization roles for a team", + "description": "Removes all assigned organization roles from a team. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], - "operationId": "orgs/update-pat-access", + "operationId": "orgs/revoke-all-org-roles-team", "externalDocs": { "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" + "url": "https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team" }, "parameters": [ { @@ -136918,8 +131296,62 @@ } }, { - "name": "pat_id", - "description": "The unique identifier of the fine-grained personal access token.", + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + } + } + }, + "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}": { + "put": { + "summary": "Assign an organization role to a team", + "description": "Assigns an organization role to a team in an organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/assign-team-to-org-role", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-team" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "role_id", + "description": "The unique identifier of the role.", "in": "path", "required": true, "schema": { @@ -136927,94 +131359,558 @@ } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "action": { - "type": "string", - "description": "Action to apply to the fine-grained personal access token.", - "enum": [ - "revoke" - ] - } - }, - "required": [ - "action" - ] - }, - "examples": { - "204": { - "summary": "Example of revoking a fine-grained personal access token.", - "value": { - "action": "revoke" - } - } - } + "responses": { + "204": { + "description": "Response" + }, + "404": { + "description": "Response if the organization, team or role does not exist." + }, + "422": { + "description": "Response if the organization roles feature is not enabled for the organization, or validation failed." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + } + }, + "delete": { + "summary": "Remove an organization role from a team", + "description": "Removes an organization role from a team. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-org-role-team", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-team" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "role_id", + "description": "The unique identifier of the role.", + "in": "path", + "required": true, + "schema": { + "type": "integer" } } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + } + } + }, + "/orgs/{org}/organization-roles/users/{username}": { + "delete": { + "summary": "Remove all organization roles for a user", + "description": "Revokes all assigned organization roles from a user. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-all-org-roles-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-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" + } + } + ], "responses": { - "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" - } - } - } - } + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + } + } + }, + "/orgs/{org}/organization-roles/users/{username}/{role_id}": { + "put": { + "summary": "Assign an organization role to a user", + "description": "Assigns an organization role to a member of an organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/assign-user-to-org-role", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-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": "role_id", + "description": "The unique identifier of the role.", + "in": "path", + "required": true, + "schema": { + "type": "integer" } + } + ], + "responses": { + "204": { + "description": "Response" }, "404": { - "description": "Resource not found", + "description": "Response if the organization, user or role does not exist." + }, + "422": { + "description": "Response if the organization roles feature is not enabled enabled for the organization, the validation failed, or the user is not an organization member." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + } + }, + "delete": { + "summary": "Remove an organization role from a user", + "description": "Remove an organization role from a user. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-org-role-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-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": "role_id", + "description": "The unique identifier of the role.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + } + } + }, + "/orgs/{org}/organization-roles/{role_id}": { + "get": { + "summary": "Get an organization role", + "description": "Gets an organization role that is available to this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/get-org-role", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "role_id", + "description": "The unique identifier of the role.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Organization Role", + "description": "Organization roles", "type": "object", "properties": { - "message": { - "type": "string" + "id": { + "description": "The unique identifier of the role.", + "type": "integer", + "format": "int64" }, - "documentation_url": { + "name": { + "description": "The name of the role.", "type": "string" }, - "url": { - "type": "string" + "description": { + "description": "A short description about who this role is for or what permissions it grants.", + "type": [ + "string", + "null" + ] }, - "status": { - "type": "string" + "base_role": { + "type": [ + "string", + "null" + ], + "description": "The system role from which this role inherits permissions.", + "enum": [ + "read", + "triage", + "write", + "maintain", + "admin", + null + ] + }, + "source": { + "type": [ + "string", + "null" + ], + "description": "Source answers the question, \"where did this role come from?\"", + "enum": [ + "Organization", + "Enterprise", + "Predefined", + null + ] + }, + "permissions": { + "description": "A list of permissions included in this role.", + "type": "array", + "items": { + "type": "string" + } + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "created_at": { + "description": "The date and time the role was created.", + "type": "string", + "format": "date-time" + }, + "updated_at": { + "description": "The date and time the role was last updated.", + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "name", + "permissions", + "organization", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 8030, + "name": "Custom Role Manager", + "description": "Permissions to manage custom roles within an org", + "permissions": [ + "write_organization_custom_repo_role", + "write_organization_custom_org_role", + "read_organization_custom_repo_role", + "read_organization_custom_org_role" + ], + "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" } } } } } }, - "204": { - "description": "A header with no content is returned." - }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -137119,21 +132015,21 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", - "subcategory": "personal-access-tokens" + "subcategory": "organization-roles" } } }, - "/orgs/{org}/personal-access-tokens/{pat_id}/repositories": { + "/orgs/{org}/organization-roles/{role_id}/teams": { "get": { - "summary": "List repositories a fine-grained personal access token has access to", - "description": "Lists the repositories a fine-grained personal access token has access to.\n\nOnly GitHub Apps can use this endpoint.", + "summary": "List teams that are assigned to an organization role", + "description": "Lists the teams that are assigned to an organization role. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, you must be an administrator for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], - "operationId": "orgs/list-pat-grant-repositories", + "operationId": "orgs/list-org-role-teams", "externalDocs": { "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" + "url": "https://docs.github.com/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role" }, "parameters": [ { @@ -137146,9 +132042,9 @@ } }, { - "name": "pat_id", + "name": "role_id", + "description": "The unique identifier of the role.", "in": "path", - "description": "Unique identifier of the fine-grained personal access token.", "required": true, "schema": { "type": "integer" @@ -137174,941 +132070,916 @@ } ], "responses": { - "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" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/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" - } - } - } - } - } - }, "200": { - "description": "Response", + "description": "Response - List of assigned teams", "content": { "application/json": { "schema": { "type": "array", + "description": "List of teams assigned to the organization role", "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", + "title": "A Role Assignment for a Team", + "description": "The Relationship a Team has with a role.", "type": "object", "properties": { - "id": { - "type": "integer", - "format": "int64", + "assignment": { + "type": "string", + "description": "Determines if the team has a direct, indirect, or mixed relationship to a role", + "enum": [ + "direct", + "indirect", + "mixed" + ], "examples": [ - 1296269 + "direct" ] }, + "id": { + "type": "integer" + }, "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] + "type": "string" }, "name": { - "type": "string", - "examples": [ - "Hello-World" - ] + "type": "string" }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" ] }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] + "pull": { + "type": "boolean" }, - "type": { - "type": "string", - "examples": [ - "User" - ] + "triage": { + "type": "boolean" }, - "site_admin": { + "push": { "type": "boolean" }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "maintain": { + "type": "boolean" }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] + "admin": { + "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" + "pull", + "triage", + "push", + "maintain", + "admin" ] }, - "private": { - "type": "boolean" + "url": { + "type": "string", + "format": "uri" }, "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat/Hello-World" + "https://github.com/orgs/rails/teams/core" ] }, - "description": { + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "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" + } + } + } + }, + "404": { + "description": "Response if the organization or role does not exist." + }, + "422": { + "description": "Response if the organization roles feature is not enabled or validation failed." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + } + } + }, + "/orgs/{org}/organization-roles/{role_id}/users": { + "get": { + "summary": "List users that are assigned to an organization role", + "description": "Lists organization members that are assigned to an organization role. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, you must be an administrator for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-org-role-users", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "role_id", + "description": "The unique identifier of the role.", + "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 - List of assigned users", + "content": { + "application/json": { + "schema": { + "type": "array", + "description": "List of users assigned to the organization role", + "items": { + "title": "A Role Assignment for a User", + "description": "The Relationship a User has with a role.", + "type": "object", + "properties": { + "assignment": { + "type": "string", + "description": "Determines if the user has a direct, indirect, or mixed relationship to a role", + "enum": [ + "direct", + "indirect", + "mixed" + ], + "examples": [ + "direct" + ] + }, + "inherited_from": { + "description": "Team the user has gotten the role through", + "type": "array", + "items": { + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + }, + "name": { "type": [ "string", "null" - ], - "examples": [ - "This your first repo!" ] }, - "fork": { - "type": "boolean" + "email": { + "type": [ + "string", + "null" + ] }, - "url": { + "login": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World" + "octocat" ] }, - "archive_url": { - "type": "string", + "id": { + "type": "integer", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + 1 ] }, - "assignees_url": { + "node_id": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + "MDQ6VXNlcjE=" ] }, - "blobs_url": { + "avatar_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + "https://github.com/images/error/octocat_happy.gif" ] }, - "branches_url": { - "type": "string", + "gravatar_id": { + "type": [ + "string", + "null" + ], "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + "41d064eb2195891e12d0413f63227ea7" ] }, - "collaborators_url": { + "url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + "https://api.github.com/users/octocat" ] }, - "comments_url": { + "html_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + "https://github.com/octocat" ] }, - "commits_url": { + "followers_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "https://api.github.com/users/octocat/followers" ] }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { + "following_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "contributors_url": { + "gists_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "deployments_url": { + "starred_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "downloads_url": { + "subscriptions_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" + "https://api.github.com/users/octocat/subscriptions" ] }, - "events_url": { + "organizations_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" + "https://api.github.com/users/octocat/orgs" ] }, - "forks_url": { + "repos_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" + "https://api.github.com/users/octocat/repos" ] }, - "git_commits_url": { + "events_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "git_refs_url": { + "received_events_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + "https://api.github.com/users/octocat/received_events" ] }, - "git_tags_url": { + "type": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + "User" ] }, - "git_url": { - "type": "string" + "site_admin": { + "type": "boolean" }, - "issue_comment_url": { + "starred_at": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + "\"2020-07-09T00:17:55Z\"" ] }, - "issue_events_url": { + "user_view_type": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "404": { + "description": "Response if the organization or role does not exist." + }, + "422": { + "description": "Response if the organization roles feature is not enabled or validation failed." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + } + } + }, + "/orgs/{org}/outside_collaborators": { + "get": { + "summary": "List outside collaborators for an organization", + "description": "List all users who are outside collaborators of an organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-outside-collaborators", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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) enabled will be returned. `2fa_insecure` means that only outside collaborators 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.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "2fa_disabled", + "2fa_insecure", + "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", + "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": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" ] }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + "email": { + "type": [ + "string", + "null" ] }, - "keys_url": { + "login": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + "octocat" ] }, - "labels_url": { - "type": "string", + "id": { + "type": "integer", + "format": "int64", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + 1 ] }, - "languages_url": { + "node_id": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" + "MDQ6VXNlcjE=" ] }, - "merges_url": { + "avatar_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" + "https://github.com/images/error/octocat_happy.gif" ] }, - "milestones_url": { - "type": "string", + "gravatar_id": { + "type": [ + "string", + "null" + ], "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + "41d064eb2195891e12d0413f63227ea7" ] }, - "notifications_url": { + "url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + "https://api.github.com/users/octocat" ] }, - "pulls_url": { + "html_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + "https://github.com/octocat" ] }, - "releases_url": { + "followers_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + "https://api.github.com/users/octocat/followers" ] }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { + "following_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "statuses_url": { + "gists_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "subscribers_url": { + "starred_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "subscription_url": { + "subscriptions_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" + "https://api.github.com/users/octocat/subscriptions" ] }, - "tags_url": { + "organizations_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" + "https://api.github.com/users/octocat/orgs" ] }, - "teams_url": { + "repos_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" + "https://api.github.com/users/octocat/repos" ] }, - "trees_url": { + "events_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "hooks_url": { + "received_events_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" + "https://api.github.com/users/octocat/received_events" ] }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { + "type": { "type": "string", "examples": [ - "admin" + "User" ] }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { + "site_admin": { "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", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# 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", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", + "starred_at": { + "type": "string", "examples": [ - 0 + "\"2020-07-09T00:17:55Z\"" ] }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", + "user_view_type": { + "type": "string", "examples": [ - false + "public" ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "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", + "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" ] } @@ -138117,122 +132988,24 @@ "default": { "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}", - "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": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "has_discussions": false, - "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 - }, - "security_and_analysis": { - "advanced_security": { - "status": "enabled" - }, - "secret_scanning": { - "status": "enabled" - }, - "secret_scanning_push_protection": { - "status": "disabled" - }, - "secret_scanning_non_provider_patterns": { - "status": "disabled" - } - } + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false } ] } @@ -138253,21 +133026,21 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", - "subcategory": "personal-access-tokens" + "subcategory": "outside-collaborators" } } }, - "/orgs/{org}/private-registries": { - "get": { - "summary": "List private registries for an organization", - "description": "\nLists all private registry configurations 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.", + "/orgs/{org}/outside_collaborators/{username}": { + "put": { + "summary": "Convert an organization member to outside collaborator", + "description": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"[Converting an organization member to an outside collaborator](https://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)\". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"", "tags": [ - "private-registries" + "orgs" ], - "operationId": "private-registries/list-org-private-registries", + "operationId": "orgs/convert-member-to-outside-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/private-registries/organization-configurations#list-private-registries-for-an-organization" + "url": "https://docs.github.com/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator" }, "parameters": [ { @@ -138280,258 +133053,8 @@ } }, { - "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", - "configurations" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "configurations": { - "type": "array", - "items": { - "title": "Organization private registry", - "description": "Private registry configuration for an organization", - "type": "object", - "properties": { - "name": { - "description": "The name of the private registry configuration.", - "type": "string", - "examples": [ - "MAVEN_REPOSITORY_SECRET" - ] - }, - "registry_type": { - "description": "The registry type.", - "enum": [ - "maven_repository", - "nuget_feed", - "goproxy_server", - "npm_registry", - "rubygems_server", - "cargo_registry", - "composer_repository", - "docker_registry", - "git_source", - "helm_registry", - "hex_organization", - "hex_repository", - "pub_repository", - "python_index", - "terraform_registry" - ], - "type": "string" - }, - "username": { - "description": "The username to use when authenticating with the private registry.", - "type": [ - "string", - "null" - ], - "examples": [ - "monalisa" - ] - }, - "visibility": { - "description": "Which type of organization repositories have access to the private registry.", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "name", - "registry_type", - "visibility", - "created_at", - "updated_at" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 1, - "configurations": [ - { - "name": "MAVEN_REPOSITORY_SECRET", - "registry_type": "maven_repository", - "username": "monalisa", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "selected" - } - ] - } - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "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", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "schemas": { - "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": "private-registries", - "subcategory": "organization-configurations" - } - }, - "post": { - "summary": "Create a private registry for an organization", - "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [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": [ - "private-registries" - ], - "operationId": "private-registries/create-org-private-registry", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/private-registries/organization-configurations#create-a-private-registry-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", + "name": "username", + "description": "The handle for the GitHub user account.", "in": "path", "required": true, "schema": { @@ -138540,552 +133063,57 @@ } ], "requestBody": { - "required": true, + "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { - "registry_type": { - "description": "The registry type.", - "type": "string", - "enum": [ - "maven_repository", - "nuget_feed", - "goproxy_server", - "npm_registry", - "rubygems_server", - "cargo_registry", - "composer_repository", - "docker_registry", - "git_source", - "helm_registry", - "hex_organization", - "hex_repository", - "pub_repository", - "python_index", - "terraform_registry" - ] - }, - "url": { - "description": "The URL of the private registry.", - "type": "string", - "format": "uri" - }, - "username": { - "description": "The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication.", - "type": [ - "string", - "null" - ] - }, - "encrypted_value": { - "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 private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint.", - "type": "string", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - }, - "key_id": { - "description": "The ID of the key you used to encrypt the secret.", - "type": "string" - }, - "visibility": { - "description": "Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry.", - "type": "string", - "enum": [ - "all", - "private", - "selected" - ] - }, - "selected_repository_ids": { - "description": "An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. You can manage the list of selected repositories using the [Update a private registry for an organization](https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) endpoint. This field should be omitted if `visibility` is set to `all` or `private`.", - "type": "array", - "items": { - "type": "integer" - } + "async": { + "type": "boolean", + "description": "When set to `true`, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.", + "default": false } - }, - "required": [ - "registry_type", - "url", - "encrypted_value", - "key_id", - "visibility" - ] + } }, "examples": { - "org-private-registry-with-private-visibility": { - "summary": "Example of a private registry configuration with private visibility", - "value": { - "registry_type": "maven_repository", - "url": "https://maven.pkg.github.com/organization/", - "username": "monalisa", - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678", - "visibility": "private" - } - }, - "org-private-registry-with-selected-visibility": { - "summary": "Example of a private registry configuration with selected visibility", + "202": { + "summary": "Status code 202, asynchronous request", "value": { - "registry_type": "maven_repository", - "url": "https://maven.pkg.github.com/organization/", - "username": "monalisa", - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678", - "visibility": "selected", - "selected_repository_ids": [ - 1296269, - 1296280 - ] + "async": true } - } - } - } - } - }, - "responses": { - "201": { - "description": "The organization private registry configuration", - "content": { - "application/json": { - "schema": { - "title": "Organization private registry", - "description": "Private registry configuration for an organization", - "type": "object", - "properties": { - "name": { - "description": "The name of the private registry configuration.", - "type": "string", - "examples": [ - "MAVEN_REPOSITORY_SECRET" - ] - }, - "registry_type": { - "description": "The registry type.", - "enum": [ - "maven_repository", - "nuget_feed", - "goproxy_server", - "npm_registry", - "rubygems_server", - "cargo_registry", - "composer_repository", - "docker_registry", - "git_source", - "helm_registry", - "hex_organization", - "hex_repository", - "pub_repository", - "python_index", - "terraform_registry" - ], - "type": "string" - }, - "username": { - "description": "The username to use when authenticating with the private registry.", - "type": "string", - "examples": [ - "monalisa" - ] - }, - "visibility": { - "description": "Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry.", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" - }, - "selected_repository_ids": { - "type": "array", - "description": "An array of repository IDs that can access the organization private registry when `visibility` is set to `selected`.", - "items": { - "type": "integer" - } - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "name", - "registry_type", - "visibility", - "created_at", - "updated_at" - ] }, - "examples": { - "org-private-registry-with-selected-visibility": { - "value": { - "name": "MAVEN_REPOSITORY_SECRET", - "registry_type": "maven_repository", - "username": "monalisa", - "visibility": "private", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z" - } - }, - "org-private-registry-with-private-visibility": { - "value": { - "name": "MAVEN_REPOSITORY_SECRET", - "registry_type": "maven_repository", - "username": "monalisa", - "visibility": "selected", - "selected_repository_ids": [ - 1296269, - 1296280 - ], - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } + "204": { + "summary": "Status code 204, synchronous request", + "value": null } } } } }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "private-registries", - "subcategory": "organization-configurations" - } - } - }, - "/orgs/{org}/private-registries/public-key": { - "get": { - "summary": "Get private registries public key for an organization", - "description": "\nGets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "private-registries" - ], - "operationId": "private-registries/get-org-public-key", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-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", + "202": { + "description": "User is getting converted asynchronously", "content": { "application/json": { "schema": { "type": "object", - "required": [ - "key_id", - "key" - ], - "properties": { - "key_id": { - "description": "The identifier for the key.", - "type": "string", - "examples": [ - "012345678912345678" - ] - }, - "key": { - "description": "The Base64 encoded public key.", - "type": "string", - "examples": [ - "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" - ] - } - } + "properties": {}, + "additionalProperties": false }, "examples": { - "default": { - "value": { - "key_id": "012345678912345678", - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" - } + "202": { + "value": null } } } - }, - "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": "private-registries", - "subcategory": "organization-configurations" - } - } - }, - "/orgs/{org}/private-registries/{secret_name}": { - "get": { - "summary": "Get a private registry for an organization", - "description": "\nGet the configuration of a single private registry defined for an organization, omitting its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "private-registries" - ], - "operationId": "private-registries/get-org-private-registry", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-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": "User was converted" }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The specified private registry configuration for the organization", - "content": { - "application/json": { - "schema": { - "title": "Organization private registry", - "description": "Private registry configuration for an organization", - "type": "object", - "properties": { - "name": { - "description": "The name of the private registry configuration.", - "type": "string", - "examples": [ - "MAVEN_REPOSITORY_SECRET" - ] - }, - "registry_type": { - "description": "The registry type.", - "enum": [ - "maven_repository", - "nuget_feed", - "goproxy_server", - "npm_registry", - "rubygems_server", - "cargo_registry", - "composer_repository", - "docker_registry", - "git_source", - "helm_registry", - "hex_organization", - "hex_repository", - "pub_repository", - "python_index", - "terraform_registry" - ], - "type": "string" - }, - "username": { - "description": "The username to use when authenticating with the private registry.", - "type": [ - "string", - "null" - ], - "examples": [ - "monalisa" - ] - }, - "visibility": { - "description": "Which type of organization repositories have access to the private registry.", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "name", - "registry_type", - "visibility", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "name": "MAVEN_REPOSITORY_SECRET", - "registry_type": "maven_repository", - "username": "monalisa", - "visibility": "private", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z" - } - } - } - } - } + "403": { + "description": "Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"" }, "404": { "description": "Resource not found", @@ -139117,20 +133145,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "private-registries", - "subcategory": "organization-configurations" + "category": "orgs", + "subcategory": "outside-collaborators" } }, - "patch": { - "summary": "Update a private registry for an organization", - "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [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.", + "delete": { + "summary": "Remove outside collaborator from an organization", + "description": "Removing a user from this list will remove them from all the organization's repositories.", "tags": [ - "private-registries" + "orgs" ], - "operationId": "private-registries/update-org-private-registry", + "operationId": "orgs/remove-outside-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization" + "url": "https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization" }, "parameters": [ { @@ -139143,8 +133171,8 @@ } }, { - "name": "secret_name", - "description": "The name of the secret.", + "name": "username", + "description": "The handle for the GitHub user account.", "in": "path", "required": true, "schema": { @@ -139152,96 +133180,15 @@ } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "registry_type": { - "description": "The registry type.", - "type": "string", - "enum": [ - "maven_repository", - "nuget_feed", - "goproxy_server", - "npm_registry", - "rubygems_server", - "cargo_registry", - "composer_repository", - "docker_registry", - "git_source", - "helm_registry", - "hex_organization", - "hex_repository", - "pub_repository", - "python_index", - "terraform_registry" - ] - }, - "url": { - "description": "The URL of the private registry.", - "type": "string", - "format": "uri" - }, - "username": { - "description": "The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication.", - "type": [ - "string", - "null" - ] - }, - "encrypted_value": { - "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 private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint.", - "type": "string", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - }, - "key_id": { - "description": "The ID of the key you used to encrypt the secret.", - "type": "string" - }, - "visibility": { - "description": "Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry.", - "type": "string", - "enum": [ - "all", - "private", - "selected" - ] - }, - "selected_repository_ids": { - "description": "An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. This field should be omitted if `visibility` is set to `all` or `private`.", - "type": "array", - "items": { - "type": "integer" - } - } - } - }, - "examples": { - "default": { - "value": { - "username": "monalisa", - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678" - } - } - } - } - } - }, "responses": { "204": { "description": "Response" }, - "404": { - "description": "Resource not found", + "422": { + "description": "Unprocessable Entity if user is a member of the organization", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", "properties": { "message": { @@ -139249,87 +133196,14 @@ }, "documentation_url": { "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" } } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } + }, + "examples": { + "response-if-user-is-a-member-of-the-organization": { + "value": { + "message": "You cannot specify an organization member to remove as an outside collaborator.", + "documentation_url": "https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization" } } } @@ -139340,161 +133214,41 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "private-registries", - "subcategory": "organization-configurations" + "category": "orgs", + "subcategory": "outside-collaborators" } - }, - "delete": { - "summary": "Delete a private registry for an organization", - "description": "\nDelete a private registry configuration at the organization-level.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + } + }, + "/orgs/{org}/packages": { + "get": { + "summary": "List packages for an organization", + "description": "Lists packages in an organization readable by the user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ - "private-registries" + "packages" ], - "operationId": "private-registries/delete-org-private-registry", + "operationId": "packages/list-packages-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization" + "url": "https://docs.github.com/rest/packages/packages#list-packages-for-an-organization" }, "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", + "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 (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "query", "required": true, "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "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" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": [ - "string", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } + "type": "string", + "enum": [ + "npm", + "maven", + "rubygems", + "docker", + "nuget", + "container" + ] } }, - "404": { - "description": "Resource not found", - "content": { - "application/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": "private-registries", - "subcategory": "organization-configurations" - } - } - }, - "/orgs/{org}/projects": { - "get": { - "summary": "List organization projects", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/list-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#list-organization-projects" - }, - "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", @@ -139505,36 +133259,35 @@ } }, { - "name": "state", - "description": "Indicates the state of the projects to return.", + "name": "visibility", + "description": "The selected visibility of the packages. This parameter is optional and only filters an existing result set.\n\nThe `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`.\nFor the list of GitHub Packages registries that support granular permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"", "in": "query", "required": false, "schema": { "type": "string", "enum": [ - "open", - "closed", - "all" - ], - "default": "open" + "public", + "private", + "internal" + ] } }, { - "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": "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": 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/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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", - "default": 1 + "default": 30 } } ], @@ -139546,81 +133299,68 @@ "schema": { "type": "array", "items": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", + "title": "Package", + "description": "A software package", "type": "object", "properties": { - "owner_url": { - "type": "string", - "format": "uri", + "id": { + "description": "Unique identifier of the package.", + "type": "integer", "examples": [ - "https://api.github.com/repos/api-playground/projects-test" + 1 ] }, - "url": { + "name": { + "description": "The name of the package.", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/projects/1002604" + "super-linter" ] }, - "html_url": { + "package_type": { "type": "string", - "format": "uri", + "enum": [ + "npm", + "maven", + "rubygems", + "docker", + "nuget", + "container" + ], "examples": [ - "https://github.com/api-playground/projects-test/projects/12" + "docker" ] }, - "columns_url": { + "url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/projects/1002604/columns" + "https://api.github.com/orgs/github/packages/container/super-linter" ] }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", + "html_url": { "type": "string", "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" + "https://github.com/orgs/github/packages/container/package/super-linter" ] }, - "number": { + "version_count": { + "description": "The number of versions of the package.", "type": "integer", "examples": [ 1 ] }, - "state": { - "description": "State of the project; either 'open' or 'closed'", + "visibility": { "type": "string", + "enum": [ + "private", + "public" + ], "examples": [ - "open" + "private" ] }, - "creator": { + "owner": { "anyOf": [ { "type": "null" @@ -139795,47 +133535,884 @@ } ] }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" + "repository": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "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", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# 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", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "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" + ] + } ] }, - "updated_at": { + "created_at": { "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] + "format": "date-time" }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "updated_at": { "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" + "format": "date-time" } }, "required": [ "id", - "node_id", - "number", "name", - "body", - "state", + "package_type", + "visibility", "url", "html_url", - "owner_url", - "creator", - "columns_url", + "version_count", "created_at", "updated_at" ] @@ -139845,67 +134422,107 @@ "default": { "value": [ { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "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/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", + "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 }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": true + "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" } ] } } } - }, - "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" + } + } } } } }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + "401": { + "description": "Requires authentication", "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" @@ -139913,40 +134530,68 @@ "documentation_url": { "type": "string" }, - "errors": { - "type": "array", - "items": { - "type": "string" - } + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } + }, + "400": { + "description": "The value of `per_page` multiplied by `page` cannot be greater than 10000." } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "post": { - "summary": "Create an organization project", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" + } + } + }, + "/orgs/{org}/packages/{package_type}/{package_name}": { + "get": { + "summary": "Get a package for an organization", + "description": "Gets a specific package in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ - "projects-classic" + "packages" ], - "operationId": "projects-classic/create-for-org", + "operationId": "packages/get-package-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#create-an-organization-project" + "url": "https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization" }, "parameters": [ + { + "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 (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "npm", + "maven", + "rubygems", + "docker", + "nuget", + "container" + ] + } + }, + { + "name": "package_name", + "description": "The name of the package.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "org", "description": "The organization name. The name is not case sensitive.", @@ -139957,118 +134602,74 @@ } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the project." - }, - "body": { - "type": "string", - "description": "The description of the project." - } - }, - "required": [ - "name" - ] - }, - "examples": { - "default": { - "value": { - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year." - } - } - } - } - } - }, "responses": { - "201": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", + "title": "Package", + "description": "A software package", "type": "object", "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", + "id": { + "description": "Unique identifier of the package.", + "type": "integer", "examples": [ - "https://api.github.com/projects/1002604" + 1 ] }, - "html_url": { + "name": { + "description": "The name of the package.", "type": "string", - "format": "uri", "examples": [ - "https://github.com/api-playground/projects-test/projects/12" + "super-linter" ] }, - "columns_url": { + "package_type": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", + "enum": [ + "npm", + "maven", + "rubygems", + "docker", + "nuget", + "container" + ], "examples": [ - 1002604 + "docker" ] }, - "node_id": { + "url": { "type": "string", "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" + "https://api.github.com/orgs/github/packages/container/super-linter" ] }, - "name": { - "description": "Name of the project", + "html_url": { "type": "string", "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" + "https://github.com/orgs/github/packages/container/package/super-linter" ] }, - "number": { + "version_count": { + "description": "The number of versions of the package.", "type": "integer", "examples": [ 1 ] }, - "state": { - "description": "State of the project; either 'open' or 'closed'", + "visibility": { "type": "string", + "enum": [ + "private", + "public" + ], "examples": [ - "open" + "private" ] }, - "creator": { + "owner": { "anyOf": [ { "type": "null" @@ -140243,830 +134844,920 @@ } ] }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "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 - }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z" - } - } - } - } - } - }, - "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" - } - } - } - } - } - }, - "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 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": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/orgs/{org}/properties/schema": { - "get": { - "summary": "Get all custom properties for an organization", - "description": "Gets all custom properties defined for an organization.\nOrganization members can read these properties.", - "tags": [ - "orgs" - ], - "operationId": "orgs/get-all-custom-properties", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/custom-properties#get-all-custom-properties-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": "array", - "items": { - "title": "Organization Custom Property", - "description": "Custom property defined on an organization", - "type": "object", - "properties": { - "property_name": { - "type": "string", - "description": "The name of the property" - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL that can be used to fetch, update, or delete info about this property via the API." - }, - "source_type": { - "type": "string", - "description": "The source type of the property", - "enum": [ - "organization", - "enterprise" - ], - "examples": [ - "organization" - ] - }, - "value_type": { - "type": "string", - "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ], - "description": "The type of the value for the property", - "examples": [ - "single_select" - ] - }, - "required": { - "type": "boolean", - "description": "Whether the property is required." - }, - "default_value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "Default value of the property", - "type": [ - "null", - "string", - "array" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "Short description of the property" - }, - "allowed_values": { - "type": [ - "array", - "null" - ], - "items": { - "type": "string", - "maxLength": 75 - }, - "maxItems": 200, - "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." - }, - "values_editable_by": { - "type": [ - "string", - "null" - ], - "enum": [ - "org_actors", - "org_and_repo_actors", - null - ], - "description": "Who can edit the values of the property", - "examples": [ - "org_actors" - ] - } - }, - "required": [ - "property_name", - "value_type" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "property_name": "environment", - "url": "https://api.github.com/orgs/github/properties/schema/environment", - "source_type": "organization", - "value_type": "single_select", - "required": true, - "default_value": "production", - "description": "Prod or dev environment", - "allowed_values": [ - "production", - "development" - ], - "values_editable_by": "org_actors" - }, - { - "property_name": "service", - "url": "https://api.github.com/orgs/github/properties/schema/service", - "source_type": "organization", - "value_type": "string" - }, - { - "property_name": "team", - "url": "https://api.github.com/orgs/github/properties/schema/team", - "source_type": "organization", - "value_type": "string", - "description": "Team owning the repository" - } - ] - } - } - } - } - }, - "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": "custom-properties" - } - }, - "patch": { - "summary": "Create or update custom properties for an organization", - "description": "Creates new or updates existing custom properties defined for an organization in a batch.\n\nIf the property already exists, the existing property will be replaced with the new values.\nMissing optional values will fall back to default values, previous values will be overwritten.\nE.g. if a property exists with `values_editable_by: org_and_repo_actors` and it's updated without specifying `values_editable_by`, it will be updated to default value `org_actors`.\n\nTo use this endpoint, the authenticated user must be one of:\n - An administrator for the organization.\n - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.", - "tags": [ - "orgs" - ], - "operationId": "orgs/create-or-update-custom-properties", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-properties-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": { - "properties": { - "type": "array", - "description": "The array of custom properties to create or update.", - "items": { - "title": "Organization Custom Property", - "description": "Custom property defined on an organization", - "type": "object", - "properties": { - "property_name": { - "type": "string", - "description": "The name of the property" - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL that can be used to fetch, update, or delete info about this property via the API." - }, - "source_type": { - "type": "string", - "description": "The source type of the property", - "enum": [ - "organization", - "enterprise" - ], - "examples": [ - "organization" - ] - }, - "value_type": { - "type": "string", - "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ], - "description": "The type of the value for the property", - "examples": [ - "single_select" - ] - }, - "required": { - "type": "boolean", - "description": "Whether the property is required." + "repository": { + "anyOf": [ + { + "type": "null" }, - "default_value": { - "oneOf": [ - { - "type": "string" + { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "Default value of the property", - "type": [ - "null", - "string", - "array" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "Short description of the property" - }, - "allowed_values": { - "type": [ - "array", - "null" - ], - "items": { - "type": "string", - "maxLength": 75 - }, - "maxItems": 200, - "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." - }, - "values_editable_by": { - "type": [ - "string", - "null" - ], - "enum": [ - "org_actors", - "org_and_repo_actors", - null - ], - "description": "Who can edit the values of the property", - "examples": [ - "org_actors" - ] - } - }, - "required": [ - "property_name", - "value_type" - ] - }, - "minItems": 1, - "maxItems": 100 - } - }, - "required": [ - "properties" - ] - }, - "examples": { - "default": { - "value": { - "properties": [ - { - "property_name": "environment", - "value_type": "single_select", - "required": true, - "default_value": "production", - "description": "Prod or dev environment", - "allowed_values": [ - "production", - "development" - ], - "values_editable_by": "org_actors" - }, - { - "property_name": "service", - "value_type": "string" - }, - { - "property_name": "team", - "value_type": "string", - "description": "Team owning the repository" - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Organization Custom Property", - "description": "Custom property defined on an organization", - "type": "object", - "properties": { - "property_name": { - "type": "string", - "description": "The name of the property" - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL that can be used to fetch, update, or delete info about this property via the API." - }, - "source_type": { - "type": "string", - "description": "The source type of the property", - "enum": [ - "organization", - "enterprise" - ], - "examples": [ - "organization" - ] - }, - "value_type": { - "type": "string", - "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ], - "description": "The type of the value for the property", - "examples": [ - "single_select" - ] - }, - "required": { - "type": "boolean", - "description": "Whether the property is required." - }, - "default_value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "Default value of the property", - "type": [ - "null", - "string", - "array" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "Short description of the property" - }, - "allowed_values": { - "type": [ - "array", - "null" - ], - "items": { - "type": "string", - "maxLength": 75 - }, - "maxItems": 200, - "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." - }, - "values_editable_by": { - "type": [ - "string", - "null" - ], - "enum": [ - "org_actors", - "org_and_repo_actors", - null - ], - "description": "Who can edit the values of the property", - "examples": [ - "org_actors" - ] - } - }, - "required": [ - "property_name", - "value_type" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "property_name": "environment", - "url": "https://api.github.com/orgs/github/properties/schema/environment", - "source_type": "organization", - "value_type": "single_select", - "required": true, - "default_value": "production", - "description": "Prod or dev environment", - "allowed_values": [ - "production", - "development" - ], - "values_editable_by": "org_actors" - }, - { - "property_name": "service", - "url": "https://api.github.com/orgs/github/properties/schema/service", - "source_type": "organization", - "value_type": "string" - }, - { - "property_name": "team", - "url": "https://api.github.com/orgs/github/properties/schema/team", - "source_type": "organization", - "value_type": "string", - "description": "Team owning the repository" - } - ] - } - } - } - } - }, - "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" + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "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", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# 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", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "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" + ] + } + ] }, - "url": { - "type": "string" + "created_at": { + "type": "string", + "format": "date-time" }, - "status": { - "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": { + "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" } } } @@ -141076,28 +135767,43 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "custom-properties" + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" } - } - }, - "/orgs/{org}/properties/schema/{custom_property_name}": { - "get": { - "summary": "Get a custom property for an organization", - "description": "Gets a custom property that is defined for an organization.\nOrganization members can read these properties.", + }, + "delete": { + "summary": "Delete a package for an organization", + "description": "Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ - "orgs" + "packages" ], - "operationId": "orgs/get-custom-property", + "operationId": "packages/delete-package-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization" + "url": "https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization" }, "parameters": [ { - "name": "org", - "description": "The organization name. The name is not case sensitive.", + "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 (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "npm", + "maven", + "rubygems", + "docker", + "nuget", + "container" + ] + } + }, + { + "name": "package_name", + "description": "The name of the package.", "in": "path", "required": true, "schema": { @@ -141105,8 +135811,8 @@ } }, { - "name": "custom_property_name", - "description": "The custom property name", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { @@ -141115,125 +135821,29 @@ } ], "responses": { - "200": { - "description": "Response", + "204": { + "description": "Response" + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { - "title": "Organization Custom Property", - "description": "Custom property defined on an organization", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "property_name": { - "type": "string", - "description": "The name of the property" - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL that can be used to fetch, update, or delete info about this property via the API." - }, - "source_type": { - "type": "string", - "description": "The source type of the property", - "enum": [ - "organization", - "enterprise" - ], - "examples": [ - "organization" - ] - }, - "value_type": { - "type": "string", - "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ], - "description": "The type of the value for the property", - "examples": [ - "single_select" - ] - }, - "required": { - "type": "boolean", - "description": "Whether the property is required." - }, - "default_value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "Default value of the property", - "type": [ - "null", - "string", - "array" - ] + "message": { + "type": "string" }, - "description": { - "type": [ - "string", - "null" - ], - "description": "Short description of the property" + "documentation_url": { + "type": "string" }, - "allowed_values": { - "type": [ - "array", - "null" - ], - "items": { - "type": "string", - "maxLength": 75 - }, - "maxItems": 200, - "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + "url": { + "type": "string" }, - "values_editable_by": { - "type": [ - "string", - "null" - ], - "enum": [ - "org_actors", - "org_and_repo_actors", - null - ], - "description": "Who can edit the values of the property", - "examples": [ - "org_actors" - ] - } - }, - "required": [ - "property_name", - "value_type" - ] - }, - "examples": { - "default": { - "value": { - "property_name": "environment", - "url": "https://api.github.com/orgs/github/properties/schema/environment", - "source_type": "organization", - "value_type": "single_select", - "required": true, - "default_value": "production", - "description": "Prod or dev environment", - "allowed_values": [ - "production", - "development" - ] + "status": { + "type": "string" } } } @@ -141266,8 +135876,8 @@ } } }, - "404": { - "description": "Resource not found", + "401": { + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -141295,26 +135905,45 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "custom-properties" + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" } - }, - "put": { - "summary": "Create or update a custom property for an organization", - "description": "Creates a new or updates an existing custom property that is defined for an organization.\n\nTo use this endpoint, the authenticated user must be one of:\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.", + } + }, + "/orgs/{org}/packages/{package_type}/{package_name}/restore": { + "post": { + "summary": "Restore a package for an organization", + "description": "Restores an entire package in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ - "orgs" + "packages" ], - "operationId": "orgs/create-or-update-custom-property", + "operationId": "packages/restore-package-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization" + "url": "https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization" }, "parameters": [ { - "name": "org", - "description": "The organization name. The name is not case sensitive.", + "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 (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "npm", + "maven", + "rubygems", + "docker", + "nuget", + "container" + ] + } + }, + { + "name": "package_name", + "description": "The name of the package.", "in": "path", "required": true, "schema": { @@ -141322,267 +135951,27 @@ } }, { - "name": "custom_property_name", - "description": "The custom property name", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } + }, + { + "name": "token", + "description": "package token", + "schema": { + "type": "string" + }, + "required": false, + "in": "query" } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "title": "Custom Property Set Payload", - "description": "Custom property set payload", - "type": "object", - "properties": { - "value_type": { - "type": "string", - "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ], - "description": "The type of the value for the property", - "examples": [ - "single_select" - ] - }, - "required": { - "type": "boolean", - "description": "Whether the property is required." - }, - "default_value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "Default value of the property", - "type": [ - "null", - "string", - "array" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "Short description of the property" - }, - "allowed_values": { - "type": [ - "array", - "null" - ], - "items": { - "type": "string", - "maxLength": 75 - }, - "maxItems": 200, - "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." - }, - "values_editable_by": { - "type": [ - "string", - "null" - ], - "enum": [ - "org_actors", - "org_and_repo_actors", - null - ], - "description": "Who can edit the values of the property", - "examples": [ - "org_actors" - ] - } - }, - "required": [ - "value_type" - ] - }, - "examples": { - "default": { - "value": { - "value_type": "single_select", - "required": true, - "default_value": "production", - "description": "Prod or dev environment", - "allowed_values": [ - "production", - "development" - ] - } - } - } - } - } - }, "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Organization Custom Property", - "description": "Custom property defined on an organization", - "type": "object", - "properties": { - "property_name": { - "type": "string", - "description": "The name of the property" - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL that can be used to fetch, update, or delete info about this property via the API." - }, - "source_type": { - "type": "string", - "description": "The source type of the property", - "enum": [ - "organization", - "enterprise" - ], - "examples": [ - "organization" - ] - }, - "value_type": { - "type": "string", - "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ], - "description": "The type of the value for the property", - "examples": [ - "single_select" - ] - }, - "required": { - "type": "boolean", - "description": "Whether the property is required." - }, - "default_value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "Default value of the property", - "type": [ - "null", - "string", - "array" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "Short description of the property" - }, - "allowed_values": { - "type": [ - "array", - "null" - ], - "items": { - "type": "string", - "maxLength": 75 - }, - "maxItems": 200, - "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." - }, - "values_editable_by": { - "type": [ - "string", - "null" - ], - "enum": [ - "org_actors", - "org_and_repo_actors", - null - ], - "description": "Who can edit the values of the property", - "examples": [ - "org_actors" - ] - } - }, - "required": [ - "property_name", - "value_type" - ] - }, - "examples": { - "default": { - "value": { - "property_name": "environment", - "url": "https://api.github.com/orgs/github/properties/schema/environment", - "source_type": "organization", - "value_type": "single_select", - "required": true, - "default_value": "production", - "description": "Prod or dev environment", - "allowed_values": [ - "production", - "development" - ] - } - } - } - } - } - }, - "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" - } - } - } - } - } + "204": { + "description": "Response" }, "404": { "description": "Resource not found", @@ -141609,49 +135998,6 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "custom-properties" - } - }, - "delete": { - "summary": "Remove a custom property for an organization", - "description": "Removes a custom property that is defined for an organization.\n\nTo use this endpoint, the authenticated user must be one of:\n - An administrator for the organization.\n - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.", - "tags": [ - "orgs" - ], - "operationId": "orgs/remove-custom-property", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "custom_property_name", - "description": "The custom property name", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "A header with no content is returned." }, "403": { "description": "Forbidden", @@ -141679,8 +136025,8 @@ } } }, - "404": { - "description": "Resource not found", + "401": { + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -141708,25 +136054,51 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "custom-properties" + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" } } }, - "/orgs/{org}/properties/values": { + "/orgs/{org}/packages/{package_type}/{package_name}/versions": { "get": { - "summary": "List custom property values for organization repositories", - "description": "Lists organization repositories with all of their custom property values.\nOrganization members can read these properties.", + "summary": "List package versions for a package owned by an organization", + "description": "Lists package versions for a package owned by an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ - "orgs" + "packages" ], - "operationId": "orgs/list-custom-properties-values-for-repos", + "operationId": "packages/get-all-package-versions-for-package-owned-by-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories" + "url": "https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization" }, "parameters": [ + { + "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 (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "npm", + "maven", + "rubygems", + "docker", + "nuget", + "container" + ] + } + }, + { + "name": "package_name", + "description": "The name of the package.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "org", "description": "The organization name. The name is not case sensitive.", @@ -141737,30 +136109,35 @@ } }, { - "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": "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": 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/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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", - "default": 1 + "default": 30 } }, { - "name": "repository_query", - "description": "Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)\" for a detailed list of qualifiers.", + "name": "state", "in": "query", "required": false, + "description": "The state of the package, either active or deleted.", "schema": { - "type": "string" + "type": "string", + "enum": [ + "active", + "deleted" + ], + "default": "active" } } ], @@ -141772,72 +136149,133 @@ "schema": { "type": "array", "items": { - "title": "Organization Repository Custom Property Values", - "description": "List of custom property values for a repository", + "title": "Package Version", + "description": "A version of a software package", "type": "object", "properties": { - "repository_id": { + "id": { + "description": "Unique identifier of the package version.", "type": "integer", "examples": [ - 1296269 + 1 ] }, - "repository_name": { + "name": { + "description": "The name of the package version.", "type": "string", "examples": [ - "Hello-World" + "latest" ] }, - "repository_full_name": { + "url": { "type": "string", "examples": [ - "octocat/Hello-World" + "https://api.github.com/orgs/github/packages/container/super-linter/versions/786068" ] }, - "properties": { - "type": "array", - "items": { - "title": "Custom Property Value", - "description": "Custom property name and associated value", - "type": "object", - "properties": { - "property_name": { - "type": "string", - "description": "The name of the property" - }, - "value": { - "oneOf": [ - { + "package_html_url": { + "type": "string", + "examples": [ + "https://github.com/orgs/github/packages/container/package/super-linter" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "https://github.com/orgs/github/packages/container/super-linter/786068" + ] + }, + "license": { + "type": "string", + "examples": [ + "MIT" + ] + }, + "description": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "deleted_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "metadata": { + "type": "object", + "title": "Package Version Metadata", + "properties": { + "package_type": { + "type": "string", + "enum": [ + "npm", + "maven", + "rubygems", + "docker", + "nuget", + "container" + ], + "examples": [ + "docker" + ] + }, + "container": { + "type": "object", + "title": "Container Metadata", + "properties": { + "tags": { + "type": "array", + "items": { "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } } - ], - "description": "The value assigned to the property", - "type": [ - "null", - "string", - "array" - ] - } + } + }, + "required": [ + "tags" + ] }, - "required": [ - "property_name", - "value" - ] + "docker": { + "type": "object", + "title": "Docker Metadata", + "properties": { + "tag": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "tags" + ] + } }, - "description": "List of custom property names and associated values" + "required": [ + "package_type" + ] } }, "required": [ - "repository_id", - "repository_name", - "repository_full_name", - "properties" + "id", + "name", + "url", + "package_html_url", + "created_at", + "updated_at" ] } }, @@ -141845,62 +136283,33 @@ "default": { "value": [ { - "repository_id": 1296269, - "repository_name": "Hello-World", - "repository_full_name": "octocat/Hello-World", - "properties": [ - { - "property_name": "environment", - "value": "production" - }, - { - "property_name": "service", - "value": "web" - }, - { - "property_name": "team", - "value": "octocat" - } - ] + "id": 245301, + "name": "1.0.4", + "url": "https://api.github.com/orgs/octo-org/packages/npm/hello-world-npm/versions/245301", + "package_html_url": "https://github.com/octo-org/hello-world-npm/packages/43752", + "created_at": "2019-11-05T22:49:04Z", + "updated_at": "2019-11-05T22:49:04Z", + "html_url": "https://github.com/octo-org/hello-world-npm/packages/43752?version=1.0.4", + "metadata": { + "package_type": "npm" + } + }, + { + "id": 209672, + "name": "1.0.3", + "url": "https://api.github.com/orgs/octo-org/packages/npm/hello-world-npm/versions/209672", + "package_html_url": "https://github.com/octo-org/hello-world-npm/packages/43752", + "created_at": "2019-10-29T15:42:11Z", + "updated_at": "2019-10-29T15:42:12Z", + "html_url": "https://github.com/octo-org/hello-world-npm/packages/43752?version=1.0.3", + "metadata": { + "package_type": "npm" + } } ] } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "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": { @@ -141928,127 +136337,6 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "custom-properties" - } - }, - "patch": { - "summary": "Create or update custom property values for organization repositories", - "description": "Create new or update existing custom property values for repositories in a batch that belong to an organization.\nEach target repository will have its custom property values updated to match the values provided in the request.\n\nA maximum of 30 repositories can be updated in a single request.\n\nUsing a value of `null` for a custom property will remove or 'unset' the property value from the repository.\n\nTo use this endpoint, the authenticated user must be one of:\n - An administrator for the organization.\n - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization.", - "tags": [ - "orgs" - ], - "operationId": "orgs/create-or-update-custom-properties-values-for-repos", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories" - }, - "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": { - "repository_names": { - "type": "array", - "description": "The names of repositories that the custom property values will be applied to.", - "items": { - "type": "string" - }, - "minItems": 1, - "maxItems": 30 - }, - "properties": { - "type": "array", - "description": "List of custom property names and associated values to apply to the repositories.", - "items": { - "title": "Custom Property Value", - "description": "Custom property name and associated value", - "type": "object", - "properties": { - "property_name": { - "type": "string", - "description": "The name of the property" - }, - "value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "The value assigned to the property", - "type": [ - "null", - "string", - "array" - ] - } - }, - "required": [ - "property_name", - "value" - ] - } - } - }, - "required": [ - "repository_names", - "properties" - ] - }, - "examples": { - "default": { - "value": { - "repository_names": [ - "Hello-World", - "octo-repo" - ], - "properties": [ - { - "property_name": "environment", - "value": "production" - }, - { - "property_name": "service", - "value": "web" - }, - { - "property_name": "team", - "value": "octocat" - } - ] - } - } - } - } - } - }, - "responses": { - "204": { - "description": "No Content when custom property values are successfully created or updated" }, "403": { "description": "Forbidden", @@ -142076,8 +136364,8 @@ } } }, - "404": { - "description": "Resource not found", + "401": { + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -142101,107 +136389,49 @@ } } } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "custom-properties" + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" } } }, - "/orgs/{org}/public_members": { + "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}": { "get": { - "summary": "List public organization members", - "description": "Members of an organization can choose to have their membership publicized or not.", + "summary": "Get a package version for an organization", + "description": "Gets a specific package version in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ - "orgs" + "packages" ], - "operationId": "orgs/list-public-members", + "operationId": "packages/get-package-version-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/members#list-public-organization-members" + "url": "https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization" }, "parameters": [ { - "name": "org", - "description": "The organization name. The name is not case sensitive.", + "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 (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "npm", + "maven", + "rubygems", + "docker", + "nuget", + "container" + ] + } + }, + { + "name": "package_name", + "description": "The name of the package.", "in": "path", "required": true, "schema": { @@ -142209,21 +136439,21 @@ } }, { - "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": "package_version_id", + "description": "Unique identifier of the package version.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" } } ], @@ -142233,235 +136463,205 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + "title": "Package Version", + "description": "A version of a software package", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the package version.", + "type": "integer", + "examples": [ + 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" - ] - } + "name": { + "description": "The name of the package version.", + "type": "string", + "examples": [ + "latest" + ] + }, + "url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/packages/container/super-linter/versions/786068" + ] + }, + "package_html_url": { + "type": "string", + "examples": [ + "https://github.com/orgs/github/packages/container/package/super-linter" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "https://github.com/orgs/github/packages/container/super-linter/786068" + ] + }, + "license": { + "type": "string", + "examples": [ + "MIT" + ] + }, + "description": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "deleted_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "metadata": { + "type": "object", + "title": "Package Version Metadata", + "properties": { + "package_type": { + "type": "string", + "enum": [ + "npm", + "maven", + "rubygems", + "docker", + "nuget", + "container" + ], + "examples": [ + "docker" + ] + }, + "container": { + "type": "object", + "title": "Container Metadata", + "properties": { + "tags": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "tags" + ] + }, + "docker": { + "type": "object", + "title": "Docker Metadata", + "properties": { + "tag": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "tags" + ] + } + }, + "required": [ + "package_type" + ] + } + }, + "required": [ + "id", + "name", + "url", + "package_html_url", + "created_at", + "updated_at" + ] }, "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": { + "id": 836, + "name": "sha256:b3d3e366b55f9a54599220198b3db5da8f53592acbbb7dc7e4e9878762fc5344", + "url": "https://api.github.com/orgs/github/packages/container/hello_docker/versions/836", + "package_html_url": "https://github.com/orgs/github/packages/container/package/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/hello_docker/836", + "metadata": { + "package_type": "container", + "container": { + "tags": [ + "latest" + ] + } } - ] + } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } } } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "members" + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" } - } - }, - "/orgs/{org}/public_members/{username}": { - "get": { - "summary": "Check public organization membership for a user", - "description": "Check if the provided user is a public member of the organization.", + }, + "delete": { + "summary": "Delete package version for an organization", + "description": "Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ - "orgs" + "packages" ], - "operationId": "orgs/check-public-membership-for-user", + "operationId": "packages/delete-package-version-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/members#check-public-organization-membership-for-a-user" + "url": "https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization" }, "parameters": [ + { + "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 (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "npm", + "maven", + "rubygems", + "docker", + "nuget", + "container" + ] + } + }, + { + "name": "package_name", + "description": "The name of the package.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "org", "description": "The organization name. The name is not case sensitive.", @@ -142472,42 +136672,145 @@ } }, { - "name": "username", - "description": "The handle for the GitHub user account.", + "name": "package_version_id", + "description": "Unique identifier of the package version.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], "responses": { "204": { - "description": "Response if user is a public member" + "description": "Response" }, "404": { - "description": "Not Found if user is not a public 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" + } + } + } + } + } + }, + "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": true, - "category": "orgs", - "subcategory": "members" + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" } - }, - "put": { - "summary": "Set public organization membership for the authenticated user", - "description": "The user can publicize their own membership. (A user cannot publicize the membership for another user.)\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", + } + }, + "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + "post": { + "summary": "Restore package version for an organization", + "description": "Restores a specific package version in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ - "orgs" + "packages" ], - "operationId": "orgs/set-public-membership-for-authenticated-user", + "operationId": "packages/restore-package-version-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user" + "url": "https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization" }, "parameters": [ + { + "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 (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "npm", + "maven", + "rubygems", + "docker", + "nuget", + "container" + ] + } + }, + { + "name": "package_name", + "description": "The name of the package.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "org", "description": "The organization name. The name is not case sensitive.", @@ -142518,12 +136821,12 @@ } }, { - "name": "username", - "description": "The handle for the GitHub user account.", + "name": "package_version_id", + "description": "Unique identifier of the package version.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], @@ -142531,6 +136834,32 @@ "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" + } + } + } + } + } + }, "403": { "description": "Forbidden", "content": { @@ -142556,25 +136885,53 @@ } } } + }, + "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": "orgs", - "subcategory": "members" + "category": "packages", + "subcategory": "packages" } - }, - "delete": { - "summary": "Remove public organization membership for the authenticated user", - "description": "Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.", + } + }, + "/orgs/{org}/personal-access-token-requests": { + "get": { + "summary": "List requests to access organization resources with fine-grained personal access tokens", + "description": "Lists requests from organization members to access organization resources with a fine-grained personal access token.\n\nOnly GitHub Apps can use this endpoint.", "tags": [ "orgs" ], - "operationId": "orgs/remove-public-membership-for-authenticated-user", + "operationId": "orgs/list-pat-grant-requests", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user" + "url": "https://docs.github.com/rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens" }, "parameters": [ { @@ -142587,8 +136944,635 @@ } }, { - "name": "username", - "description": "The handle for the GitHub user account.", + "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": "sort", + "description": "The property by which to sort the results.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created_at" + ], + "default": "created_at" + } + }, + { + "name": "direction", + "description": "The direction to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "owner", + "description": "A list of owner usernames to use to filter the results.", + "in": "query", + "required": false, + "schema": { + "type": "array", + "maxItems": 10, + "items": { + "type": "string" + }, + "examples": [ + "owner[]=octocat1,owner[]=octocat2" + ] + } + }, + { + "name": "repository", + "description": "The name of the repository to use to filter the results.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "examples": [ + "Hello-World" + ] + } + }, + { + "name": "permission", + "description": "The permission to use to filter the results.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "examples": [ + "issues_read" + ] + } + }, + { + "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) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "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) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "name": "token_id", + "description": "The ID of the token", + "in": "query", + "required": false, + "schema": { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + }, + "examples": [ + "token_id[]=1,token_id[]=2" + ] + } + } + ], + "responses": { + "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" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/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" + } + } + } + } + } + }, + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Simple Organization Programmatic Access Grant Request", + "description": "Minimal representation of an organization programmatic access grant request for enumerations", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the request for access via fine-grained personal access token. The `pat_request_id` used to review PAT requests." + }, + "reason": { + "type": [ + "string", + "null" + ], + "description": "Reason for requesting access." + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "repository_selection": { + "type": "string", + "enum": [ + "none", + "all", + "subset" + ], + "description": "Type of repository selection requested." + }, + "repositories_url": { + "type": "string", + "description": "URL to the list of repositories requested to be accessed via fine-grained personal access token. Should only be followed when `repository_selection` is `subset`." + }, + "permissions": { + "type": "object", + "description": "Permissions requested, categorized by type of permission.", + "properties": { + "organization": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "repository": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "other": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "created_at": { + "type": "string", + "description": "Date and time when the request for access was created." + }, + "token_id": { + "type": "integer", + "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." + }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, + "token_expired": { + "type": "boolean", + "description": "Whether the associated fine-grained personal access token has expired." + }, + "token_expires_at": { + "type": [ + "string", + "null" + ], + "description": "Date and time when the associated fine-grained personal access token expires." + }, + "token_last_used_at": { + "type": [ + "string", + "null" + ], + "description": "Date and time when the associated fine-grained personal access token was last used for authentication." + } + }, + "required": [ + "id", + "reason", + "owner", + "repository_selection", + "repositories_url", + "permissions", + "created_at", + "token_id", + "token_name", + "token_expired", + "token_expires_at", + "token_last_used_at" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 25381, + "reason": "I need to access the GitHub API", + "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_selection": "all", + "repositories_url": "https://api.github.com/organizations/652551/personal-access-token-requests/25381/repositories", + "permissions": { + "organization": { + "members": "read" + }, + "repository": { + "metadata": "read" + } + }, + "created_at": "2023-05-16T08:47:09.000-07:00", + "token_id": 98716, + "token_name": "Some Token", + "token_expired": false, + "token_expires_at": "2023-11-16T08:47:09.000-07:00", + "token_last_used_at": null + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "personal-access-tokens" + } + }, + "post": { + "summary": "Review requests to access organization resources with fine-grained personal access tokens", + "description": "Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token.\n\nOnly GitHub Apps can use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/review-pat-grant-requests-in-bulk", + "externalDocs": { + "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": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { @@ -142596,30 +137580,248 @@ } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "pat_request_ids": { + "type": "array", + "description": "Unique identifiers of the requests for access via fine-grained personal access token. Must be formed of between 1 and 100 `pat_request_id` values.", + "items": { + "type": "integer" + }, + "minItems": 1, + "maxItems": 100 + }, + "action": { + "type": "string", + "description": "Action to apply to the requests.", + "enum": [ + "approve", + "deny" + ] + }, + "reason": { + "type": [ + "string", + "null" + ], + "description": "Reason for approving or denying the requests. Max 1024 characters.", + "maxLength": 1024 + } + }, + "required": [ + "action" + ] + }, + "examples": { + "204": { + "summary": "Example of denying a request", + "value": { + "pat_request_ids": [ + 42, + 73 + ], + "action": "deny", + "reason": "Access is too broad." + } + } + } + } + } + }, "responses": { - "204": { - "description": "Response" + "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" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/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" + } + } + } + } + } + }, + "202": { + "description": "Accepted", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "default": { + "value": null + } + } + } + } } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "orgs", - "subcategory": "members" + "subcategory": "personal-access-tokens" } } }, - "/orgs/{org}/repos": { - "get": { - "summary": "List organization repositories", - "description": "Lists repositories for the specified organization.\n\n> [!NOTE]\n> In order to see the `security_and_analysis` block for a repository 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).\"", + "/orgs/{org}/personal-access-token-requests/{pat_request_id}": { + "post": { + "summary": "Review a request to access organization resources with a fine-grained personal access token", + "description": "Approves or denies a pending request to access organization resources via a fine-grained personal access token.\n\nOnly GitHub Apps can use this endpoint.", "tags": [ - "repos" + "orgs" ], - "operationId": "repos/list-for-org", + "operationId": "orgs/review-pat-grant-request", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/repos#list-organization-repositories" + "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": [ { @@ -142632,50 +137834,250 @@ } }, { - "name": "type", - "description": "Specifies the types of repositories you want returned.", - "in": "query", - "required": false, + "name": "pat_request_id", + "in": "path", + "description": "Unique identifier of the request for access via fine-grained personal access token.", + "required": true, "schema": { - "type": "string", - "enum": [ - "all", - "public", - "private", - "forks", - "sources", - "member" - ], - "default": "all" + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "action": { + "type": "string", + "description": "Action to apply to the request.", + "enum": [ + "approve", + "deny" + ] + }, + "reason": { + "type": [ + "string", + "null" + ], + "description": "Reason for approving or denying the request. Max 1024 characters.", + "maxLength": 1024 + } + }, + "required": [ + "action" + ] + }, + "examples": { + "204": { + "summary": "Example of denying a request", + "value": { + "action": "deny", + "reason": "This request is denied because the access is too broad." + } + } + } + } + } + }, + "responses": { + "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" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/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" + } + } + } + } } }, + "204": { + "description": "A header with no content is returned." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "personal-access-tokens" + } + } + }, + "/orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories": { + "get": { + "summary": "List repositories requested to be accessed by a fine-grained personal access token", + "description": "Lists the repositories a fine-grained personal access token request is requesting access to.\n\nOnly GitHub Apps can use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-pat-grant-request-repositories", + "externalDocs": { + "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": [ { - "name": "sort", - "description": "The property 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": [ - "created", - "updated", - "pushed", - "full_name" - ], - "default": "created" + "type": "string" } }, { - "name": "direction", - "description": "The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`.", - "in": "query", - "required": false, + "name": "pat_request_id", + "in": "path", + "description": "Unique identifier of the request for access via fine-grained personal access token.", + "required": true, "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ] + "type": "integer" } }, { @@ -142698,6 +138100,84 @@ } ], "responses": { + "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" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/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" + } + } + } + } + } + }, "200": { "description": "Response", "content": { @@ -143698,20 +139178,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "repos" + "category": "orgs", + "subcategory": "personal-access-tokens" } - }, - "post": { - "summary": "Create an organization repository", - "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.", + } + }, + "/orgs/{org}/personal-access-tokens": { + "get": { + "summary": "List fine-grained personal access tokens with access to organization resources", + "description": "Lists approved fine-grained personal access tokens owned by organization members that can access organization resources.\n\nOnly GitHub Apps can use this endpoint.", "tags": [ - "repos" + "orgs" ], - "operationId": "repos/create-in-org", + "operationId": "orgs/list-pat-grants", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/repos#create-an-organization-repository" + "url": "https://docs.github.com/rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources" }, "parameters": [ { @@ -143722,1973 +139204,4032 @@ "schema": { "type": "string" } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository." - }, - "description": { - "type": "string", - "description": "A short description of the repository." - }, - "homepage": { - "type": "string", - "description": "A URL with more information about the repository." - }, - "private": { - "type": "boolean", - "description": "Whether the repository is private.", - "default": false - }, - "visibility": { - "type": "string", - "description": "The visibility of the repository.", - "enum": [ - "public", - "private" - ] - }, - "has_issues": { - "type": "boolean", - "description": "Either `true` to enable issues for this repository or `false` to disable them.", - "default": true - }, - "has_projects": { - "type": "boolean", - "description": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", - "default": true - }, - "has_wiki": { - "type": "boolean", - "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", - "default": true - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "is_template": { - "type": "boolean", - "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", - "default": false - }, - "team_id": { - "type": "integer", - "description": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization." - }, - "auto_init": { - "type": "boolean", - "description": "Pass `true` to create an initial commit with empty README.", - "default": false - }, - "gitignore_template": { - "type": "string", - "description": "Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, \"Haskell\"." - }, - "license_template": { - "type": "string", - "description": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\"." - }, - "allow_squash_merge": { - "type": "boolean", - "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", - "default": true - }, - "allow_merge_commit": { - "type": "boolean", - "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", - "default": true - }, - "allow_rebase_merge": { - "type": "boolean", - "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", - "default": true - }, - "allow_auto_merge": { - "type": "boolean", - "description": "Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge.", - "default": false - }, - "delete_branch_on_merge": { - "type": "boolean", - "description": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. **The authenticated user must be an organization owner to set this property to `true`.**", - "default": false - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **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": "Required when using `squash_merge_commit_message`.\n\nThe 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": "Required when using `merge_commit_message`.\n\nThe 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." - }, - "custom_properties": { - "type": "object", - "description": "The custom properties for the new repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - } - }, - "required": [ - "name" - ] + }, + { + "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": "sort", + "description": "The property by which to sort the results.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created_at" + ], + "default": "created_at" + } + }, + { + "name": "direction", + "description": "The direction to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "owner", + "description": "A list of owner usernames to use to filter the results.", + "in": "query", + "required": false, + "schema": { + "type": "array", + "maxItems": 10, + "items": { + "type": "string" }, - "examples": { - "default": { - "value": { - "name": "Hello-World", - "description": "This is your first repository", - "homepage": "https://github.com", - "private": false, - "has_issues": true, - "has_projects": true, - "has_wiki": true - } - } - } + "examples": [ + "owner[]=octocat1,owner[]=octocat2" + ] } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Full Repository", - "description": "Full Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] + }, + { + "name": "repository", + "description": "The name of the repository to use to filter the results.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "examples": [ + "Hello-World" + ] + } + }, + { + "name": "permission", + "description": "The permission to use to filter the results.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "examples": [ + "issues_read" + ] + } + }, + { + "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) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "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) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "name": "token_id", + "description": "The ID of the token", + "in": "query", + "required": false, + "schema": { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + }, + "examples": [ + "token_id[]=1,token_id[]=2" + ] + } + } + ], + "responses": { + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "fork": { - "type": "boolean" + "documentation_url": { + "type": "string" }, "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] + "type": "string" }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] + "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" }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] + "documentation_url": { + "type": "string" }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] + "documentation_url": { + "type": "string" }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] + "url": { + "type": "string" }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] + "documentation_url": { + "type": "string" }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] + "url": { + "type": "string" }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] + "status": { + "type": "string" + } + } + } + } + } + }, + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Organization Programmatic Access Grant", + "description": "Minimal representation of an organization programmatic access grant for enumerations", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the fine-grained personal access token grant. The `pat_id` used to get details about an approved fine-grained personal access token." + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "repository_selection": { + "type": "string", + "enum": [ + "none", + "all", + "subset" + ], + "description": "Type of repository selection requested." + }, + "repositories_url": { + "type": "string", + "description": "URL to the list of repositories the fine-grained personal access token can access. Only follow when `repository_selection` is `subset`." + }, + "permissions": { + "type": "object", + "description": "Permissions requested, categorized by type of permission.", + "properties": { + "organization": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "repository": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "other": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "access_granted_at": { + "type": "string", + "description": "Date and time when the fine-grained personal access token was approved to access the organization." + }, + "token_id": { + "type": "integer", + "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." + }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, + "token_expired": { + "type": "boolean", + "description": "Whether the associated fine-grained personal access token has expired." + }, + "token_expires_at": { + "type": [ + "string", + "null" + ], + "description": "Date and time when the associated fine-grained personal access token expires." + }, + "token_last_used_at": { + "type": [ + "string", + "null" + ], + "description": "Date and time when the associated fine-grained personal access token was last used for authentication." + } }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] + "required": [ + "id", + "owner", + "repository_selection", + "repositories_url", + "permissions", + "access_granted_at", + "token_id", + "token_name", + "token_expired", + "token_expires_at", + "token_last_used_at" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 25381, + "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_selection": "all", + "repositories_url": "https://api.github.com/organizations/652551/personal-access-tokens/25381/repositories", + "permissions": { + "organization": { + "members": "read" + }, + "repository": { + "metadata": "read" + } + }, + "access_granted_at": "2023-05-16T08:47:09.000-07:00", + "token_id": 98716, + "token_name": "Some Token", + "token_expired": false, + "token_expires_at": "2023-11-16T08:47:09.000-07:00", + "token_last_used_at": null + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "personal-access-tokens" + } + }, + "post": { + "summary": "Update the access to organization resources via fine-grained personal access tokens", + "description": "Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access.\n\nOnly GitHub Apps can use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/update-pat-accesses", + "externalDocs": { + "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": [ + { + "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": { + "action": { + "type": "string", + "description": "Action to apply to the fine-grained personal access token.", + "enum": [ + "revoke" + ] + }, + "pat_ids": { + "description": "The IDs of the fine-grained personal access tokens.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the fine-grained personal access token." }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] + "minItems": 1, + "maxItems": 100 + } + }, + "required": [ + "action", + "pat_ids" + ] + }, + "examples": { + "204": { + "summary": "Example of revoking a fine-grained personal access token.", + "value": { + "action": "revoke", + "pat_ids": [ + 1296269, + 1296280 + ] + } + } + } + } + } + }, + "responses": { + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] + "documentation_url": { + "type": "string" }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] + "url": { + "type": "string" }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] + "documentation_url": { + "type": "string" }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] + "url": { + "type": "string" }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] + "status": { + "type": "string" + } + } + } + } + } + }, + "202": { + "description": "Accepted", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] + "documentation_url": { + "type": "string" }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] + "url": { + "type": "string" }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] + "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" }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] + "documentation_url": { + "type": "string" }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "personal-access-tokens" + } + } + }, + "/orgs/{org}/personal-access-tokens/{pat_id}": { + "post": { + "summary": "Update the access a fine-grained personal access token has to organization resources", + "description": "Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access.\n\nOnly GitHub Apps can use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/update-pat-access", + "externalDocs": { + "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": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pat_id", + "description": "The unique identifier of the fine-grained personal access token.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "action": { + "type": "string", + "description": "Action to apply to the fine-grained personal access token.", + "enum": [ + "revoke" + ] + } + }, + "required": [ + "action" + ] + }, + "examples": { + "204": { + "summary": "Example of revoking a fine-grained personal access token.", + "value": { + "action": "revoke" + } + } + } + } + } + }, + "responses": { + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] + "documentation_url": { + "type": "string" }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] + "url": { + "type": "string" }, - "language": { - "type": [ - "string", - "null" - ] + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] + "documentation_url": { + "type": "string" }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] + "url": { + "type": "string" }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] + "status": { + "type": "string" + } + } + } + } + } + }, + "204": { + "description": "A header with no content is returned." + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] + "documentation_url": { + "type": "string" }, - "default_branch": { - "type": "string", - "examples": [ - "master" - ] + "url": { + "type": "string" }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] + "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" }, - "is_template": { - "type": "boolean", - "examples": [ - true - ] + "documentation_url": { + "type": "string" }, - "topics": { + "errors": { "type": "array", "items": { - "type": "string" - }, - "examples": [ - "octocat", - "atom", - "electron", - "API" - ] - }, - "has_issues": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "personal-access-tokens" + } + } + }, + "/orgs/{org}/personal-access-tokens/{pat_id}/repositories": { + "get": { + "summary": "List repositories a fine-grained personal access token has access to", + "description": "Lists the repositories a fine-grained personal access token has access to.\n\nOnly GitHub Apps can use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-pat-grant-repositories", + "externalDocs": { + "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": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pat_id", + "in": "path", + "description": "Unique identifier of the fine-grained personal access token.", + "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": { + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "has_downloads": { - "type": "boolean", - "examples": [ - true - ] + "documentation_url": { + "type": "string" }, - "has_discussions": { - "type": "boolean", - "examples": [ - true - ] + "url": { + "type": "string" }, - "archived": { - "type": "boolean" + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." + "documentation_url": { + "type": "string" }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "type": "string", - "examples": [ - "public" - ] + "url": { + "type": "string" }, - "pushed_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] + "documentation_url": { + "type": "string" }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] + "url": { + "type": "string" }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } + "status": { + "type": "string" + } + } + } + } + } + }, + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "allow_rebase_merge": { - "type": "boolean", - "examples": [ - true - ] - }, - "template_repository": { - "anyOf": [ - { - "type": "null" + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "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" + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "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", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# 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", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "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" + ] } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] } } }, - "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" - ] + "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": [ + { + "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": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "has_discussions": false, + "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 + }, + "security_and_analysis": { + "advanced_security": { + "status": "enabled" + }, + "secret_scanning": { + "status": "enabled" + }, + "secret_scanning_push_protection": { + "status": "disabled" + }, + "secret_scanning_non_provider_patterns": { + "status": "disabled" + } + } + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "personal-access-tokens" + } + } + }, + "/orgs/{org}/private-registries": { + "get": { + "summary": "List private registries for an organization", + "description": "\nLists all private registry configurations 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": [ + "private-registries" + ], + "operationId": "private-registries/list-org-private-registries", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/private-registries/organization-configurations#list-private-registries-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", + "configurations" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "configurations": { + "type": "array", + "items": { + "title": "Organization private registry", + "description": "Private registry configuration for an organization", + "type": "object", + "properties": { + "name": { + "description": "The name of the private registry configuration.", + "type": "string", + "examples": [ + "MAVEN_REPOSITORY_SECRET" + ] + }, + "registry_type": { + "description": "The registry type.", + "enum": [ + "maven_repository", + "nuget_feed", + "goproxy_server", + "npm_registry", + "rubygems_server", + "cargo_registry", + "composer_repository", + "docker_registry", + "git_source", + "helm_registry", + "hex_organization", + "hex_repository", + "pub_repository", + "python_index", + "terraform_registry" + ], + "type": "string" + }, + "username": { + "description": "The username to use when authenticating with the private registry.", + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa" + ] + }, + "visibility": { + "description": "Which type of organization repositories have access to the private registry.", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "name", + "registry_type", + "visibility", + "created_at", + "updated_at" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 1, + "configurations": [ + { + "name": "MAVEN_REPOSITORY_SECRET", + "registry_type": "maven_repository", + "username": "monalisa", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected" } ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "temp_clone_token": { + "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", "null" ] }, - "allow_squash_merge": { - "type": "boolean", - "examples": [ - true + "documentation_url": { + "type": [ + "string", + "null" ] }, - "allow_auto_merge": { - "type": "boolean", - "examples": [ - false + "detail": { + "type": [ + "string", + "null" ] }, - "delete_branch_on_merge": { - "type": "boolean", - "examples": [ - false - ] + "status": { + "type": "integer" }, - "allow_merge_commit": { - "type": "boolean", - "examples": [ - true + "scimType": { + "type": [ + "string", + "null" ] }, - "allow_update_branch": { - "type": "boolean", - "examples": [ - true - ] + "schemas": { + "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" }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "examples": [ - false - ] + "documentation_url": { + "type": "string" }, - "squash_merge_commit_title": { + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "private-registries", + "subcategory": "organization-configurations" + } + }, + "post": { + "summary": "Create a private registry for an organization", + "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [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": [ + "private-registries" + ], + "operationId": "private-registries/create-org-private-registry", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/private-registries/organization-configurations#create-a-private-registry-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": { + "registry_type": { + "description": "The registry type.", + "type": "string", + "enum": [ + "maven_repository", + "nuget_feed", + "goproxy_server", + "npm_registry", + "rubygems_server", + "cargo_registry", + "composer_repository", + "docker_registry", + "git_source", + "helm_registry", + "hex_organization", + "hex_repository", + "pub_repository", + "python_index", + "terraform_registry" + ] + }, + "url": { + "description": "The URL of the private registry.", + "type": "string", + "format": "uri" + }, + "username": { + "description": "The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication.", + "type": [ + "string", + "null" + ] + }, + "encrypted_value": { + "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 private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint.", + "type": "string", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "description": "The ID of the key you used to encrypt the secret.", + "type": "string" + }, + "visibility": { + "description": "Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry.", + "type": "string", + "enum": [ + "all", + "private", + "selected" + ] + }, + "selected_repository_ids": { + "description": "An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. You can manage the list of selected repositories using the [Update a private registry for an organization](https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) endpoint. This field should be omitted if `visibility` is set to `all` or `private`.", + "type": "array", + "items": { + "type": "integer" + } + } + }, + "required": [ + "registry_type", + "url", + "encrypted_value", + "key_id", + "visibility" + ] + }, + "examples": { + "org-private-registry-with-private-visibility": { + "summary": "Example of a private registry configuration with private visibility", + "value": { + "registry_type": "maven_repository", + "url": "https://maven.pkg.github.com/organization/", + "username": "monalisa", + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "private" + } + }, + "org-private-registry-with-selected-visibility": { + "summary": "Example of a private registry configuration with selected visibility", + "value": { + "registry_type": "maven_repository", + "url": "https://maven.pkg.github.com/organization/", + "username": "monalisa", + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "The organization private registry configuration", + "content": { + "application/json": { + "schema": { + "title": "Organization private registry", + "description": "Private registry configuration for an organization", + "type": "object", + "properties": { + "name": { + "description": "The name of the private registry configuration.", "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).", "examples": [ - "PR_TITLE" + "MAVEN_REPOSITORY_SECRET" ] }, - "squash_merge_commit_message": { - "type": "string", + "registry_type": { + "description": "The registry type.", "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" + "maven_repository", + "nuget_feed", + "goproxy_server", + "npm_registry", + "rubygems_server", + "cargo_registry", + "composer_repository", + "docker_registry", + "git_source", + "helm_registry", + "hex_organization", + "hex_repository", + "pub_repository", + "python_index", + "terraform_registry" ], - "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.", - "examples": [ - "PR_BODY" - ] + "type": "string" }, - "merge_commit_title": { + "username": { + "description": "The username to use when authenticating with the private registry.", "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).", "examples": [ - "PR_TITLE" + "monalisa" ] }, - "merge_commit_message": { - "type": "string", + "visibility": { + "description": "Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry.", "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" + "all", + "private", + "selected" ], - "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.", + "type": "string" + }, + "selected_repository_ids": { + "type": "array", + "description": "An array of repository IDs that can access the organization private registry when `visibility` is set to `selected`.", + "items": { + "type": "integer" + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "name", + "registry_type", + "visibility", + "created_at", + "updated_at" + ] + }, + "examples": { + "org-private-registry-with-selected-visibility": { + "value": { + "name": "MAVEN_REPOSITORY_SECRET", + "registry_type": "maven_repository", + "username": "monalisa", + "visibility": "private", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + } + }, + "org-private-registry-with-private-visibility": { + "value": { + "name": "MAVEN_REPOSITORY_SECRET", + "registry_type": "maven_repository", + "username": "monalisa", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 + ], + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "private-registries", + "subcategory": "organization-configurations" + } + } + }, + "/orgs/{org}/private-registries/public-key": { + "get": { + "summary": "Get private registries public key for an organization", + "description": "\nGets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "private-registries" + ], + "operationId": "private-registries/get-org-public-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "key_id", + "key" + ], + "properties": { + "key_id": { + "description": "The identifier for the key.", + "type": "string", "examples": [ - "PR_BODY" + "012345678912345678" ] }, - "allow_forking": { - "type": "boolean", + "key": { + "description": "The Base64 encoded public key.", + "type": "string", "examples": [ - true + "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" ] + } + } + }, + "examples": { + "default": { + "value": { + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + } + } + } + } + }, + "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" }, - "web_commit_signoff_required": { - "type": "boolean", + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "private-registries", + "subcategory": "organization-configurations" + } + } + }, + "/orgs/{org}/private-registries/{secret_name}": { + "get": { + "summary": "Get a private registry for an organization", + "description": "\nGet the configuration of a single private registry defined for an organization, omitting its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "private-registries" + ], + "operationId": "private-registries/get-org-private-registry", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization" + }, + "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": "The specified private registry configuration for the organization", + "content": { + "application/json": { + "schema": { + "title": "Organization private registry", + "description": "Private registry configuration for an organization", + "type": "object", + "properties": { + "name": { + "description": "The name of the private registry configuration.", + "type": "string", "examples": [ - false + "MAVEN_REPOSITORY_SECRET" ] }, - "subscribers_count": { + "registry_type": { + "description": "The registry type.", + "enum": [ + "maven_repository", + "nuget_feed", + "goproxy_server", + "npm_registry", + "rubygems_server", + "cargo_registry", + "composer_repository", + "docker_registry", + "git_source", + "helm_registry", + "hex_organization", + "hex_repository", + "pub_repository", + "python_index", + "terraform_registry" + ], + "type": "string" + }, + "username": { + "description": "The username to use when authenticating with the private registry.", + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa" + ] + }, + "visibility": { + "description": "Which type of organization repositories have access to the private registry.", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "name", + "registry_type", + "visibility", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "name": "MAVEN_REPOSITORY_SECRET", + "registry_type": "maven_repository", + "username": "monalisa", + "visibility": "private", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/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": "private-registries", + "subcategory": "organization-configurations" + } + }, + "patch": { + "summary": "Update a private registry for an organization", + "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [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": [ + "private-registries" + ], + "operationId": "private-registries/update-org-private-registry", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization" + }, + "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": { + "registry_type": { + "description": "The registry type.", + "type": "string", + "enum": [ + "maven_repository", + "nuget_feed", + "goproxy_server", + "npm_registry", + "rubygems_server", + "cargo_registry", + "composer_repository", + "docker_registry", + "git_source", + "helm_registry", + "hex_organization", + "hex_repository", + "pub_repository", + "python_index", + "terraform_registry" + ] + }, + "url": { + "description": "The URL of the private registry.", + "type": "string", + "format": "uri" + }, + "username": { + "description": "The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication.", + "type": [ + "string", + "null" + ] + }, + "encrypted_value": { + "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 private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint.", + "type": "string", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "description": "The ID of the key you used to encrypt the secret.", + "type": "string" + }, + "visibility": { + "description": "Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry.", + "type": "string", + "enum": [ + "all", + "private", + "selected" + ] + }, + "selected_repository_ids": { + "description": "An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. This field should be omitted if `visibility` is set to `all` or `private`.", + "type": "array", + "items": { + "type": "integer" + } + } + } + }, + "examples": { + "default": { + "value": { + "username": "monalisa", + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "private-registries", + "subcategory": "organization-configurations" + } + }, + "delete": { + "summary": "Delete a private registry for an organization", + "description": "\nDelete a private registry configuration at the organization-level.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "private-registries" + ], + "operationId": "private-registries/delete-org-private-registry", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization" + }, + "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" + }, + "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "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": "private-registries", + "subcategory": "organization-configurations" + } + } + }, + "/orgs/{org}/projects": { + "get": { + "summary": "List organization projects", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "tags": [ + "projects-classic" + ], + "operationId": "projects-classic/list-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects-classic/projects#list-organization-projects" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "state", + "description": "Indicates the state of the projects to return.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "open", + "closed", + "all" + ], + "default": "open" + } + }, + { + "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": "Project", + "description": "Projects are a way to organize columns and cards of work.", + "type": "object", + "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/api-playground/projects-test/projects/12" + ] + }, + "columns_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604/columns" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6UHJvamVjdDEwMDI2MDQ=" + ] + }, + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", + "type": [ + "string", + "null" + ], + "examples": [ + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "type": "string", + "enum": [ + "read", + "write", + "admin", + "none" + ] + }, + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "number", + "name", + "body", + "state", + "url", + "html_url", + "owner_url", + "creator", + "columns_url", + "created_at", + "updated_at" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "owner_url": "https://api.github.com/orgs/octocat", + "url": "https://api.github.com/projects/1002605", + "html_url": "https://github.com/orgs/api-playground/projects/1", + "columns_url": "https://api.github.com/projects/1002605/columns", + "id": 1002605, + "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", + "name": "Organization Roadmap", + "body": "High-level roadmap for the upcoming year.", + "number": 1, + "state": "open", + "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 + }, + "created_at": "2011-04-11T20:09:31Z", + "updated_at": "2014-03-04T18:58:10Z", + "organization_permission": "write", + "private": true + } + ] + } + } + } + }, + "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 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": "projects-classic", + "subcategory": "projects", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true + }, + "post": { + "summary": "Create an organization project", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "tags": [ + "projects-classic" + ], + "operationId": "projects-classic/create-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects-classic/projects#create-an-organization-project" + }, + "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 project." + }, + "body": { + "type": "string", + "description": "The description of the project." + } + }, + "required": [ + "name" + ] + }, + "examples": { + "default": { + "value": { + "name": "Organization Roadmap", + "body": "High-level roadmap for the upcoming year." + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", + "type": "object", + "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/api-playground/projects-test/projects/12" + ] + }, + "columns_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604/columns" + ] + }, + "id": { "type": "integer", "examples": [ - 42 + 1002604 ] }, - "network_count": { + "node_id": { + "type": "string", + "examples": [ + "MDc6UHJvamVjdDEwMDI2MDQ=" + ] + }, + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", + "type": [ + "string", + "null" + ], + "examples": [ + "This project represents the sprint of the first week in January" + ] + }, + "number": { "type": "integer", "examples": [ - 0 + 1 ] }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" ] }, - "organization": { + "creator": { "anyOf": [ { "type": "null" @@ -145863,306 +143404,557 @@ } ] }, - "parent": { - "title": "Repository", - "description": "A repository on GitHub.", + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "type": "string", + "enum": [ + "read", + "write", + "admin", + "none" + ] + }, + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "number", + "name", + "body", + "state", + "url", + "html_url", + "owner_url", + "creator", + "columns_url", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "owner_url": "https://api.github.com/orgs/octocat", + "url": "https://api.github.com/projects/1002605", + "html_url": "https://github.com/orgs/api-playground/projects/1", + "columns_url": "https://api.github.com/projects/1002605/columns", + "id": 1002605, + "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", + "name": "Organization Roadmap", + "body": "High-level roadmap for the upcoming year.", + "number": 1, + "state": "open", + "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 + }, + "created_at": "2011-04-11T20:09:31Z", + "updated_at": "2014-03-04T18:58:10Z" + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "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 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": "projects-classic", + "subcategory": "projects", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true + } + }, + "/orgs/{org}/properties/schema": { + "get": { + "summary": "Get all custom properties for an organization", + "description": "Gets all custom properties defined for an organization.\nOrganization members can read these properties.", + "tags": [ + "orgs" + ], + "operationId": "orgs/get-all-custom-properties", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/custom-properties#get-all-custom-properties-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": "array", + "items": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "examples": [ + "organization" + ] + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": [ + "string", + "null" + ], + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "org_actors" + ] + } + }, + "required": [ + "property_name", + "value_type" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "property_name": "environment", + "url": "https://api.github.com/orgs/github/properties/schema/environment", + "source_type": "organization", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ], + "values_editable_by": "org_actors" + }, + { + "property_name": "service", + "url": "https://api.github.com/orgs/github/properties/schema/service", + "source_type": "organization", + "value_type": "string" + }, + { + "property_name": "team", + "url": "https://api.github.com/orgs/github/properties/schema/team", + "source_type": "organization", + "value_type": "string", + "description": "Team owning the repository" + } + ] + } + } + } + } + }, + "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": "custom-properties" + } + }, + "patch": { + "summary": "Create or update custom properties for an organization", + "description": "Creates new or updates existing custom properties defined for an organization in a batch.\n\nIf the property already exists, the existing property will be replaced with the new values.\nMissing optional values will fall back to default values, previous values will be overwritten.\nE.g. if a property exists with `values_editable_by: org_and_repo_actors` and it's updated without specifying `values_editable_by`, it will be updated to default value `org_actors`.\n\nTo use this endpoint, the authenticated user must be one of:\n - An administrator for the organization.\n - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/create-or-update-custom-properties", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-properties-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": { + "properties": { + "type": "array", + "description": "The array of custom properties to create or update.", + "items": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", "type": "object", "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] + "property_name": { + "type": "string", + "description": "The name of the property" }, - "node_id": { + "url": { "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." }, - "name": { - "description": "The name of the repository.", + "source_type": { "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], "examples": [ - "Team Environment" + "organization" ] }, - "full_name": { + "value_type": { "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", "examples": [ - "octocat/Hello-World" + "single_select" ] }, - "license": { - "anyOf": [ + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ { - "type": "null" + "type": "string" }, { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] + "type": "array", + "items": { + "type": "string" + } } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" ] }, "description": { @@ -146170,2362 +143962,1283 @@ "string", "null" ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] + "description": "Short description of the property" }, - "mirror_url": { + "allowed_values": { "type": [ - "string", + "array", "null" ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." }, - "homepage": { + "values_editable_by": { "type": [ "string", "null" ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ], + "description": "Who can edit the values of the property", "examples": [ - 108 + "org_actors" ] - }, - "default_branch": { - "description": "The default branch of the repository.", + } + }, + "required": [ + "property_name", + "value_type" + ] + }, + "minItems": 1, + "maxItems": 100 + } + }, + "required": [ + "properties" + ] + }, + "examples": { + "default": { + "value": { + "properties": [ + { + "property_name": "environment", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ], + "values_editable_by": "org_actors" + }, + { + "property_name": "service", + "value_type": "string" + }, + { + "property_name": "team", + "value_type": "string", + "description": "Team owning the repository" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "examples": [ + "organization" + ] + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] + "maxLength": 75 }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": [ + "string", + "null" + ], + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "org_actors" + ] + } + }, + "required": [ + "property_name", + "value_type" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "property_name": "environment", + "url": "https://api.github.com/orgs/github/properties/schema/environment", + "source_type": "organization", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ], + "values_editable_by": "org_actors" + }, + { + "property_name": "service", + "url": "https://api.github.com/orgs/github/properties/schema/service", + "source_type": "organization", + "value_type": "string" + }, + { + "property_name": "team", + "url": "https://api.github.com/orgs/github/properties/schema/team", + "source_type": "organization", + "value_type": "string", + "description": "Team owning the repository" + } + ] + } + } + } + } + }, + "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": "custom-properties" + } + } + }, + "/orgs/{org}/properties/schema/{custom_property_name}": { + "get": { + "summary": "Get a custom property for an organization", + "description": "Gets a custom property that is defined for an organization.\nOrganization members can read these properties.", + "tags": [ + "orgs" + ], + "operationId": "orgs/get-custom-property", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "custom_property_name", + "description": "The custom property name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "examples": [ + "organization" + ] + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" }, - "topics": { + { "type": "array", "items": { "type": "string" } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": [ + "string", + "null" + ], + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "org_actors" + ] + } + }, + "required": [ + "property_name", + "value_type" + ] + }, + "examples": { + "default": { + "value": { + "property_name": "environment", + "url": "https://api.github.com/orgs/github/properties/schema/environment", + "source_type": "organization", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + } + } + } + } + } + }, + "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": "custom-properties" + } + }, + "put": { + "summary": "Create or update a custom property for an organization", + "description": "Creates a new or updates an existing custom property that is defined for an organization.\n\nTo use this endpoint, the authenticated user must be one of:\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/create-or-update-custom-property", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "custom_property_name", + "description": "The custom property name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Custom Property Set Payload", + "description": "Custom property set payload", + "type": "object", + "properties": { + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { + } + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": [ + "string", + "null" + ], + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "org_actors" + ] + } + }, + "required": [ + "value_type" + ] + }, + "examples": { + "default": { + "value": { + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "examples": [ + "organization" + ] + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { "type": "string" }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } + { + "type": "array", + "items": { + "type": "string" } } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 }, - "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" + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": [ + "string", + "null" + ], + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "org_actors" + ] + } + }, + "required": [ + "property_name", + "value_type" + ] + }, + "examples": { + "default": { + "value": { + "property_name": "environment", + "url": "https://api.github.com/orgs/github/properties/schema/environment", + "source_type": "organization", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" ] + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "source": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", + "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": "custom-properties" + } + }, + "delete": { + "summary": "Remove a custom property for an organization", + "description": "Removes a custom property that is defined for an organization.\n\nTo use this endpoint, the authenticated user must be one of:\n - An administrator for the organization.\n - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/remove-custom-property", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "custom_property_name", + "description": "The custom property name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "A header with no content is returned." + }, + "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": "custom-properties" + } + } + }, + "/orgs/{org}/properties/values": { + "get": { + "summary": "List custom property values for organization repositories", + "description": "Lists organization repositories with all of their custom property values.\nOrganization members can read these properties.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-custom-properties-values-for-repos", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories" + }, + "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": "repository_query", + "description": "Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)\" for a detailed list of qualifiers.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Organization Repository Custom Property Values", + "description": "List of custom property values for a repository", + "type": "object", + "properties": { + "repository_id": { + "type": "integer", + "examples": [ + 1296269 + ] + }, + "repository_name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "repository_full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" + "type": "array", + "items": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] + "value": { + "oneOf": [ + { + "type": "string" }, - "html_url": { - "type": "string", - "format": "uri" + { + "type": "array", + "items": { + "type": "string" + } } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" + ], + "description": "The value assigned to the property", + "type": [ + "null", + "string", + "array" ] } - ] - }, - "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" + "property_name", + "value" ] }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + "description": "List of custom property names and associated values" + } + }, + "required": [ + "repository_id", + "repository_name", + "repository_full_name", + "properties" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "repository_id": 1296269, + "repository_name": "Hello-World", + "repository_full_name": "octocat/Hello-World", + "properties": [ + { + "property_name": "environment", + "value": "production" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" } - } - }, - "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" - ] + ] + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "forks": { - "type": "integer" + "documentation_url": { + "type": "string" }, - "master_branch": { + "url": { "type": "string" }, - "open_issues": { - "type": "integer" + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "watchers": { - "type": "integer" + "documentation_url": { + "type": "string" }, - "anonymous_access_enabled": { - "description": "Whether anonymous git access is allowed.", - "default": true, - "type": "boolean" + "url": { + "type": "string" }, - "code_of_conduct": { - "title": "Code Of Conduct Simple", - "description": "Code of Conduct Simple", + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-properties" + } + }, + "patch": { + "summary": "Create or update custom property values for organization repositories", + "description": "Create new or update existing custom property values for repositories in a batch that belong to an organization.\nEach target repository will have its custom property values updated to match the values provided in the request.\n\nA maximum of 30 repositories can be updated in a single request.\n\nUsing a value of `null` for a custom property will remove or 'unset' the property value from the repository.\n\nTo use this endpoint, the authenticated user must be one of:\n - An administrator for the organization.\n - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/create-or-update-custom-properties-values-for-repos", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories" + }, + "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": { + "repository_names": { + "type": "array", + "description": "The names of repositories that the custom property values will be applied to.", + "items": { + "type": "string" + }, + "minItems": 1, + "maxItems": 30 + }, + "properties": { + "type": "array", + "description": "List of custom property names and associated values to apply to the repositories.", + "items": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/github/docs/community/code_of_conduct" - ] - }, - "key": { - "type": "string", - "examples": [ - "citizen_code_of_conduct" - ] - }, - "name": { + "property_name": { "type": "string", - "examples": [ - "Citizen Code of Conduct" - ] + "description": "The name of the property" }, - "html_url": { + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "The value assigned to the property", "type": [ + "null", "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md" + "array" ] } }, "required": [ - "url", - "key", - "name", - "html_url" + "property_name", + "value" ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "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", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "has_discussions", - "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", - "network_count", - "subscribers_count" - ] + } }, - "examples": { - "default": { - "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}", - "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", - "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" - }, - "language": null, - "forks_count": 9, - "forks": 9, - "stargazers_count": 80, - "watchers_count": 80, - "watchers": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "open_issues": 0, - "is_template": false, - "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": { - "pull": true, - "push": false, - "admin": false - }, - "allow_rebase_merge": true, - "template_repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World-Template", - "full_name": "octocat/Hello-World-Template", - "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-Template", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World-Template", - "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World-Template.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World-Template.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World-Template.git", - "mirror_url": "git:git.example.com/octocat/Hello-World-Template", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World-Template", - "homepage": "https://github.com", - "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, - "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", - "allow_squash_merge": true, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "allow_forking": true, - "web_commit_signoff_required": false, - "subscribers_count": 42, - "network_count": 0, - "organization": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "Organization", - "site_admin": false + "required": [ + "repository_names", + "properties" + ] + }, + "examples": { + "default": { + "value": { + "repository_names": [ + "Hello-World", + "octo-repo" + ], + "properties": [ + { + "property_name": "environment", + "value": "production" }, - "parent": { - "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, - "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://api.github.com/licenses/mit" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 + { + "property_name": "service", + "value": "web" }, - "source": { - "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, - "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://api.github.com/licenses/mit" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 + { + "property_name": "team", + "value": "octocat" } - } + ] } } } - }, - "headers": { - "Location": { - "example": "https://api.github.com/repos/octocat/Hello-World", + } + } + }, + "responses": { + "204": { + "description": "No Content when custom property values are successfully created or updated" + }, + "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" + } + } } } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -148629,28 +145342,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "repos" + "category": "orgs", + "subcategory": "custom-properties" } } }, - "/orgs/{org}/rulesets": { + "/orgs/{org}/public_members": { "get": { - "summary": "Get all organization repository rulesets", - "description": "Get all the repository rulesets for an organization.", + "summary": "List public organization members", + "description": "Members of an organization can choose to have their membership publicized or not.", "tags": [ - "repos" + "orgs" ], - "operationId": "repos/get-org-rulesets", + "operationId": "orgs/list-public-members", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/rules#get-all-organization-repository-rulesets" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "rules" + "url": "https://docs.github.com/rest/orgs/members#list-public-organization-members" }, "parameters": [ { @@ -148679,18 +145386,6 @@ "type": "integer", "default": 1 } - }, - { - "name": "targets", - "description": "A comma-separated list of rule targets to filter by.\nIf provided, only rulesets that apply to the specified targets will be returned.\nFor example, `branch,tag,push`.\n", - "in": "query", - "required": false, - "schema": { - "type": "string", - "examples": [ - "branch,tag,push" - ] - } } ], "responses": { @@ -148701,1325 +145396,304 @@ "schema": { "type": "array", "items": { - "title": "Repository ruleset", + "title": "Simple User", + "description": "A GitHub user.", "type": "object", - "description": "A set of rules to apply when specified conditions are met.", - "required": [ - "id", - "name", - "source", - "enforcement" - ], "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, "id": { "type": "integer", - "description": "The ID of the ruleset" + "format": "int64", + "examples": [ + 1 + ] }, - "name": { + "node_id": { "type": "string", - "description": "The name of the ruleset" + "examples": [ + "MDQ6VXNlcjE=" + ] }, - "target": { + "avatar_url": { "type": "string", - "description": "The target of the ruleset", - "enum": [ - "branch", - "tag", - "push", - "repository" + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" ] }, - "source_type": { + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { "type": "string", - "description": "The type of the source of the ruleset", - "enum": [ - "Repository", - "Organization", - "Enterprise" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" ] }, - "source": { + "html_url": { "type": "string", - "description": "The name of the source" + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] }, - "enforcement": { + "followers_url": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).", - "enum": [ - "disabled", - "active", - "evaluate" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" ] }, - "bypass_actors": { - "type": "array", - "description": "The actors that can bypass the rules in this ruleset", - "items": { - "title": "Repository Ruleset Bypass Actor", - "type": "object", - "description": "An actor that can bypass rules in a ruleset", - "required": [ - "actor_type" - ], - "properties": { - "actor_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." - }, - "actor_type": { - "type": "string", - "enum": [ - "Integration", - "OrganizationAdmin", - "RepositoryRole", - "Team", - "DeployKey" - ], - "description": "The type of actor that can bypass a ruleset." - }, - "bypass_mode": { - "type": "string", - "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", - "enum": [ - "always", - "pull_request" - ], - "default": "always" - } - } - } + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] }, - "current_user_can_bypass": { + "gists_url": { "type": "string", - "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", - "enum": [ - "always", - "pull_requests_only", - "never" + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "node_id": { - "type": "string" + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The URL of the ruleset" - } - } - }, - "html": { - "type": [ - "object", - "null" - ], - "properties": { - "href": { - "type": "string", - "description": "The html URL of the ruleset" - } - } - } - } + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] }, - "conditions": { - "anyOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Organization ruleset conditions", - "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", - "oneOf": [ - { - "type": "object", - "title": "repository_name_and_ref_name", - "description": "Conditions to target repositories by name and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository names", - "type": "object", - "description": "Parameters for a repository name condition", - "properties": { - "repository_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - }, - "protected": { - "type": "boolean", - "description": "Whether renaming of target repositories is prevented." - } - } - } - }, - "required": [ - "repository_name" - ] - } - ] - }, - { - "type": "object", - "title": "repository_id_and_ref_name", - "description": "Conditions to target repositories by id and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository IDs", - "type": "object", - "description": "Parameters for a repository ID condition", - "properties": { - "repository_id": { - "type": "object", - "properties": { - "repository_ids": { - "type": "array", - "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", - "items": { - "type": "integer" - } - } - } - } - }, - "required": [ - "repository_id" - ] - } - ] - }, - { - "type": "object", - "title": "repository_property_and_ref_name", - "description": "Conditions to target repositories by property and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository properties", - "type": "object", - "description": "Parameters for a repository property condition", - "properties": { - "repository_property": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - }, - "exclude": { - "type": "array", - "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - } - } - } - }, - "required": [ - "repository_property" - ] - } - ] - } - ] - } - ], - "type": [ - "null", - "object" + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" ] }, - "rules": { - "type": "array", - "items": { - "title": "Repository Rule", - "type": "object", - "description": "A repository rule.", - "oneOf": [ - { - "title": "creation", - "description": "Only allow users with bypass permission to create matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "creation" - ] - } - } - }, - { - "title": "update", - "description": "Only allow users with bypass permission to update matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "update" - ] - }, - "parameters": { - "type": "object", - "properties": { - "update_allows_fetch_and_merge": { - "type": "boolean", - "description": "Branch can pull changes from its upstream repository" - } - }, - "required": [ - "update_allows_fetch_and_merge" - ] - } - } - }, - { - "title": "deletion", - "description": "Only allow users with bypass permissions to delete matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "deletion" - ] - } - } - }, - { - "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_linear_history" - ] - } - } - }, - { - "title": "merge_queue", - "description": "Merges must be performed via a merge queue.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "merge_queue" - ] - }, - "parameters": { - "type": "object", - "properties": { - "check_response_timeout_minutes": { - "type": "integer", - "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", - "minimum": 1, - "maximum": 360 - }, - "grouping_strategy": { - "type": "string", - "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", - "enum": [ - "ALLGREEN", - "HEADGREEN" - ] - }, - "max_entries_to_build": { - "type": "integer", - "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", - "minimum": 0, - "maximum": 100 - }, - "max_entries_to_merge": { - "type": "integer", - "description": "The maximum number of PRs that will be merged together in a group.", - "minimum": 0, - "maximum": 100 - }, - "merge_method": { - "type": "string", - "description": "Method to use when merging changes from queued pull requests.", - "enum": [ - "MERGE", - "SQUASH", - "REBASE" - ] - }, - "min_entries_to_merge": { - "type": "integer", - "description": "The minimum number of PRs that will be merged together in a group.", - "minimum": 0, - "maximum": 100 - }, - "min_entries_to_merge_wait_minutes": { - "type": "integer", - "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", - "minimum": 0, - "maximum": 360 - } - }, - "required": [ - "check_response_timeout_minutes", - "grouping_strategy", - "max_entries_to_build", - "max_entries_to_merge", - "merge_method", - "min_entries_to_merge", - "min_entries_to_merge_wait_minutes" - ] - } - } - }, - { - "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_deployments" - ] - }, - "parameters": { - "type": "object", - "properties": { - "required_deployment_environments": { - "type": "array", - "description": "The environments that must be successfully deployed to before branches can be merged.", - "items": { - "type": "string" - } - } - }, - "required": [ - "required_deployment_environments" - ] - } - } - }, - { - "title": "required_signatures", - "description": "Commits pushed to matching refs must have verified signatures.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_signatures" - ] - } - } - }, - { - "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.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "pull_request" - ] - }, - "parameters": { - "type": "object", - "properties": { - "allowed_merge_methods": { - "type": "array", - "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", - "items": { - "type": "string", - "enum": [ - "merge", - "squash", - "rebase" - ] - } - }, - "automatic_copilot_code_review_enabled": { - "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean", - "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." - }, - "require_code_owner_review": { - "type": "boolean", - "description": "Require an approving review in pull requests that modify files that have a designated code owner." - }, - "require_last_push_approval": { - "type": "boolean", - "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." - }, - "required_approving_review_count": { - "type": "integer", - "description": "The number of approving reviews that are required before a pull request can be merged.", - "minimum": 0, - "maximum": 10 - }, - "required_review_thread_resolution": { - "type": "boolean", - "description": "All conversations on code must be resolved before a pull request can be merged." - } - }, - "required": [ - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "require_last_push_approval", - "required_approving_review_count", - "required_review_thread_resolution" - ] - } - } - }, - { - "title": "required_status_checks", - "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_status_checks" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "required_status_checks": { - "type": "array", - "description": "Status checks that are required.", - "items": { - "title": "StatusCheckConfiguration", - "description": "Required status check", - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "The status check context name that must be present on the commit." - }, - "integration_id": { - "type": "integer", - "description": "The optional integration ID that this status check must originate from." - } - }, - "required": [ - "context" - ] - } - }, - "strict_required_status_checks_policy": { - "type": "boolean", - "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." - } - }, - "required": [ - "required_status_checks", - "strict_required_status_checks_policy" - ] - } - } - }, - { - "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "non_fast_forward" - ] - } - } - }, - { - "title": "commit_message_pattern", - "description": "Parameters to be used for the commit_message_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_message_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "commit_author_email_pattern", - "description": "Parameters to be used for the commit_author_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_author_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "committer_email_pattern", - "description": "Parameters to be used for the committer_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "committer_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "branch_name_pattern", - "description": "Parameters to be used for the branch_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "branch_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "tag_name_pattern", - "description": "Parameters to be used for the tag_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tag_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - } - ] - } + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] }, - "created_at": { + "events_url": { "type": "string", - "format": "date-time" + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] }, - "updated_at": { + "received_events_url": { "type": "string", - "format": "date-time" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] } }, "examples": { "default": { "value": [ { - "id": 21, - "name": "super cool ruleset", - "source_type": "Organization", - "source": "my-org", - "enforcement": "enabled", - "node_id": "RRS_lACkVXNlcgQB", - "_links": { - "self": { - "href": "https://api.github.com/orgs/my-org/rulesets/21" - }, - "html": { - "href": "https://github.com/organizations/my-org/settings/rules/21" - } - }, - "created_at": "2023-07-15T08:43:03Z", - "updated_at": "2023-08-23T16:29:47Z" - }, - { - "id": 432, - "name": "Another ruleset", - "source_type": "Organization", - "source": "my-org", - "enforcement": "enabled", - "node_id": "RRS_lACkVXNlcgQQ", - "_links": { - "self": { - "href": "https://api.github.com/orgs/my-org/rulesets/432" - }, - "html": { - "href": "https://github.com/organizations/my-org/settings/rules/432" - } - }, - "created_at": "2023-08-15T08:43:03Z", - "updated_at": "2023-09-23T16:29:47Z" + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false } ] } } } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } + "type": "string" } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "members" + } + } + }, + "/orgs/{org}/public_members/{username}": { + "get": { + "summary": "Check public organization membership for a user", + "description": "Check if the provided user is a public member of the organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/check-public-membership-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/members#check-public-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" + } }, - "500": { - "description": "Internal Error", + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response if user is a public member" + }, + "404": { + "description": "Not Found if user is not a public member" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "members" + } + }, + "put": { + "summary": "Set public organization membership for the authenticated user", + "description": "The user can publicize their own membership. (A user cannot publicize the membership for another user.)\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "tags": [ + "orgs" + ], + "operationId": "orgs/set-public-membership-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/members#set-public-organization-membership-for-the-authenticated-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" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -150044,24 +145718,69 @@ } } } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "orgs", + "subcategory": "members" } }, - "post": { - "summary": "Create an organization repository ruleset", - "description": "Create a repository ruleset for an organization.", + "delete": { + "summary": "Remove public organization membership for the authenticated user", + "description": "Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.", "tags": [ - "repos" + "orgs" ], - "operationId": "repos/create-org-ruleset", + "operationId": "orgs/remove-public-membership-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/rules#create-an-organization-repository-ruleset" + "url": "https://docs.github.com/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-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" + } + } + ], + "responses": { + "204": { + "description": "Response" + } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, + "enabledForGitHubApps": false, "category": "orgs", - "subcategory": "rules" + "subcategory": "members" + } + } + }, + "/orgs/{org}/repos": { + "get": { + "summary": "List organization repositories", + "description": "Lists repositories for the specified organization.\n\n> [!NOTE]\n> In order to see the `security_and_analysis` block for a repository 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).\"", + "tags": [ + "repos" + ], + "operationId": "repos/list-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#list-organization-repositories" }, "parameters": [ { @@ -150072,2512 +145791,1088 @@ "schema": { "type": "string" } + }, + { + "name": "type", + "description": "Specifies the types of repositories you want returned.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "all", + "public", + "private", + "forks", + "sources", + "member" + ], + "default": "all" + } + }, + { + "name": "sort", + "description": "The property to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "pushed", + "full_name" + ], + "default": "created" + } + }, + { + "name": "direction", + "description": "The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "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/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": { - "description": "Request body", - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the ruleset." - }, - "target": { - "type": "string", - "description": "The target of the ruleset", - "enum": [ - "branch", - "tag", - "push", - "repository" - ], - "default": "branch" - }, - "enforcement": { - "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).", - "enum": [ - "disabled", - "active", - "evaluate" - ] - }, - "bypass_actors": { - "type": "array", - "description": "The actors that can bypass the rules in this ruleset", - "items": { - "title": "Repository Ruleset Bypass Actor", - "type": "object", - "description": "An actor that can bypass rules in a ruleset", - "required": [ - "actor_type" - ], - "properties": { - "actor_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." - }, - "actor_type": { - "type": "string", - "enum": [ - "Integration", - "OrganizationAdmin", - "RepositoryRole", - "Team", - "DeployKey" - ], - "description": "The type of actor that can bypass a ruleset." - }, - "bypass_mode": { - "type": "string", - "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", - "enum": [ - "always", - "pull_request" - ], - "default": "always" - } - } - } - }, - "conditions": { - "title": "Organization ruleset conditions", + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", - "oneOf": [ - { - "type": "object", - "title": "repository_name_and_ref_name", - "description": "Conditions to target repositories by name and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository names", - "type": "object", - "description": "Parameters for a repository name condition", - "properties": { - "repository_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - }, - "protected": { - "type": "boolean", - "description": "Whether renaming of target repositories is prevented." - } - } - } - }, - "required": [ - "repository_name" - ] - } + "properties": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 ] }, - { - "type": "object", - "title": "repository_id_and_ref_name", - "description": "Conditions to target repositories by id and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository IDs", - "type": "object", - "description": "Parameters for a repository ID condition", - "properties": { - "repository_id": { - "type": "object", - "properties": { - "repository_ids": { - "type": "array", - "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", - "items": { - "type": "integer" - } - } - } - } - }, - "required": [ - "repository_id" - ] - } + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - { + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", - "title": "repository_property_and_ref_name", - "description": "Conditions to target repositories by property and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - { - "title": "Repository ruleset conditions for repository properties", - "type": "object", - "description": "Parameters for a repository property condition", - "properties": { - "repository_property": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - }, - "exclude": { - "type": "array", - "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - } - } - } - }, - "required": [ - "repository_property" + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] - } - ] - } - ] - }, - "rules": { - "type": "array", - "description": "An array of rules within the ruleset.", - "items": { - "title": "Repository Rule", - "type": "object", - "description": "A repository rule.", - "oneOf": [ - { - "title": "creation", - "description": "Only allow users with bypass permission to create matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "creation" - ] - } - } - }, - { - "title": "update", - "description": "Only allow users with bypass permission to update matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "update" - ] - }, - "parameters": { - "type": "object", - "properties": { - "update_allows_fetch_and_merge": { - "type": "boolean", - "description": "Branch can pull changes from its upstream repository" - } - }, - "required": [ - "update_allows_fetch_and_merge" - ] - } - } - }, - { - "title": "deletion", - "description": "Only allow users with bypass permissions to delete matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "deletion" - ] - } - } - }, - { - "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_linear_history" - ] - } - } - }, - { - "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_deployments" - ] - }, - "parameters": { - "type": "object", - "properties": { - "required_deployment_environments": { - "type": "array", - "description": "The environments that must be successfully deployed to before branches can be merged.", - "items": { - "type": "string" - } - } - }, - "required": [ - "required_deployment_environments" - ] - } - } - }, - { - "title": "required_signatures", - "description": "Commits pushed to matching refs must have verified signatures.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_signatures" - ] - } - } - }, - { - "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.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "pull_request" - ] - }, - "parameters": { - "type": "object", - "properties": { - "allowed_merge_methods": { - "type": "array", - "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", - "items": { - "type": "string", - "enum": [ - "merge", - "squash", - "rebase" - ] - } - }, - "automatic_copilot_code_review_enabled": { - "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean", - "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." - }, - "require_code_owner_review": { - "type": "boolean", - "description": "Require an approving review in pull requests that modify files that have a designated code owner." - }, - "require_last_push_approval": { - "type": "boolean", - "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." - }, - "required_approving_review_count": { - "type": "integer", - "description": "The number of approving reviews that are required before a pull request can be merged.", - "minimum": 0, - "maximum": 10 - }, - "required_review_thread_resolution": { - "type": "boolean", - "description": "All conversations on code must be resolved before a pull request can be merged." - } - }, - "required": [ - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "require_last_push_approval", - "required_approving_review_count", - "required_review_thread_resolution" - ] - } - } - }, - { - "title": "required_status_checks", - "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_status_checks" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "required_status_checks": { - "type": "array", - "description": "Status checks that are required.", - "items": { - "title": "StatusCheckConfiguration", - "description": "Required status check", - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "The status check context name that must be present on the commit." - }, - "integration_id": { - "type": "integer", - "description": "The optional integration ID that this status check must originate from." - } - }, - "required": [ - "context" - ] - } - }, - "strict_required_status_checks_policy": { - "type": "boolean", - "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." - } - }, - "required": [ - "required_status_checks", - "strict_required_status_checks_policy" - ] - } - } - }, - { - "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "non_fast_forward" - ] - } } }, - { - "title": "commit_message_pattern", - "description": "Parameters to be used for the commit_message_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_message_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "commit_author_email_pattern", - "description": "Parameters to be used for the commit_author_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_author_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "committer_email_pattern", - "description": "Parameters to be used for the committer_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "committer_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "branch_name_pattern", - "description": "Parameters to be used for the branch_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "branch_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "tag_name_pattern", - "description": "Parameters to be used for the tag_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tag_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "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" } - ] - } - } - }, - "required": [ - "name", - "enforcement" - ] - }, - "examples": { - "default": { - "value": { - "name": "super cool ruleset", - "target": "branch", - "enforcement": "active", - "bypass_actors": [ - { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" - } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" + }, + "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", + "null" ], - "exclude": [ - "refs/heads/dev*" + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" ] }, - "repository_name": { - "include": [ - "important_repository", - "another_important_repository" + "created_at": { + "type": [ + "string", + "null" ], - "exclude": [ - "unimportant_repository" + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" ], - "protected": true - } - }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } - } - ] - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Repository ruleset", - "type": "object", - "description": "A set of rules to apply when specified conditions are met.", - "required": [ - "id", - "name", - "source", - "enforcement" - ], - "properties": { - "id": { - "type": "integer", - "description": "The ID of the ruleset" - }, - "name": { - "type": "string", - "description": "The name of the ruleset" - }, - "target": { - "type": "string", - "description": "The target of the ruleset", - "enum": [ - "branch", - "tag", - "push", - "repository" - ] - }, - "source_type": { - "type": "string", - "description": "The type of the source of the ruleset", - "enum": [ - "Repository", - "Organization", - "Enterprise" - ] - }, - "source": { - "type": "string", - "description": "The name of the source" - }, - "enforcement": { - "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).", - "enum": [ - "disabled", - "active", - "evaluate" - ] - }, - "bypass_actors": { - "type": "array", - "description": "The actors that can bypass the rules in this ruleset", - "items": { - "title": "Repository Ruleset Bypass Actor", + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { "type": "object", - "description": "An actor that can bypass rules in a ruleset", - "required": [ - "actor_type" - ], "properties": { - "actor_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + "admin": { + "type": "boolean" }, - "actor_type": { - "type": "string", - "enum": [ - "Integration", - "OrganizationAdmin", - "RepositoryRole", - "Team", - "DeployKey" - ], - "description": "The type of actor that can bypass a ruleset." + "maintain": { + "type": "boolean" }, - "bypass_mode": { - "type": "string", - "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", - "enum": [ - "always", - "pull_request" - ], - "default": "always" - } - } - } - }, - "current_user_can_bypass": { - "type": "string", - "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", - "enum": [ - "always", - "pull_requests_only", - "never" - ] - }, - "node_id": { - "type": "string" - }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The URL of the ruleset" - } - } - }, - "html": { - "type": [ - "object", - "null" - ], - "properties": { - "href": { - "type": "string", - "description": "The html URL of the ruleset" - } - } - } - } - }, - "conditions": { - "anyOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" } - }, - { - "title": "Organization ruleset conditions", - "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", - "oneOf": [ - { - "type": "object", - "title": "repository_name_and_ref_name", - "description": "Conditions to target repositories by name and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository names", - "type": "object", - "description": "Parameters for a repository name condition", - "properties": { - "repository_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - }, - "protected": { - "type": "boolean", - "description": "Whether renaming of target repositories is prevented." - } - } - } - }, - "required": [ - "repository_name" - ] - } - ] - }, - { - "type": "object", - "title": "repository_id_and_ref_name", - "description": "Conditions to target repositories by id and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository IDs", - "type": "object", - "description": "Parameters for a repository ID condition", - "properties": { - "repository_id": { - "type": "object", - "properties": { - "repository_ids": { - "type": "array", - "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", - "items": { - "type": "integer" - } - } - } - } - }, - "required": [ - "repository_id" - ] - } - ] - }, - { - "type": "object", - "title": "repository_property_and_ref_name", - "description": "Conditions to target repositories by property and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository properties", - "type": "object", - "description": "Parameters for a repository property condition", - "properties": { - "repository_property": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - }, - "exclude": { - "type": "array", - "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - } - } - } - }, - "required": [ - "repository_property" - ] - } - ] - } - ] } - ], - "type": [ - "null", - "object" - ] - }, - "rules": { - "type": "array", - "items": { - "title": "Repository Rule", + }, + "role_name": { + "type": "string", + "examples": [ + "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", - "description": "A repository rule.", - "oneOf": [ - { - "title": "creation", - "description": "Only allow users with bypass permission to create matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "creation" - ] - } - } - }, - { - "title": "update", - "description": "Only allow users with bypass permission to update matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "update" - ] - }, - "parameters": { - "type": "object", - "properties": { - "update_allows_fetch_and_merge": { - "type": "boolean", - "description": "Branch can pull changes from its upstream repository" - } - }, - "required": [ - "update_allows_fetch_and_merge" - ] - } - } - }, - { - "title": "deletion", - "description": "Only allow users with bypass permissions to delete matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "deletion" - ] - } - } + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] }, - { - "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_linear_history" - ] - } - } + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] }, - { - "title": "merge_queue", - "description": "Merges must be performed via a merge queue.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "merge_queue" - ] - }, - "parameters": { - "type": "object", - "properties": { - "check_response_timeout_minutes": { - "type": "integer", - "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", - "minimum": 1, - "maximum": 360 - }, - "grouping_strategy": { - "type": "string", - "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", - "enum": [ - "ALLGREEN", - "HEADGREEN" - ] - }, - "max_entries_to_build": { - "type": "integer", - "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", - "minimum": 0, - "maximum": 100 - }, - "max_entries_to_merge": { - "type": "integer", - "description": "The maximum number of PRs that will be merged together in a group.", - "minimum": 0, - "maximum": 100 - }, - "merge_method": { - "type": "string", - "description": "Method to use when merging changes from queued pull requests.", - "enum": [ - "MERGE", - "SQUASH", - "REBASE" - ] - }, - "min_entries_to_merge": { - "type": "integer", - "description": "The minimum number of PRs that will be merged together in a group.", - "minimum": 0, - "maximum": 100 - }, - "min_entries_to_merge_wait_minutes": { - "type": "integer", - "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", - "minimum": 0, - "maximum": 360 - } - }, - "required": [ - "check_response_timeout_minutes", - "grouping_strategy", - "max_entries_to_build", - "max_entries_to_merge", - "merge_method", - "min_entries_to_merge", - "min_entries_to_merge_wait_minutes" - ] - } - } + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] }, - { - "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_deployments" - ] - }, - "parameters": { - "type": "object", - "properties": { - "required_deployment_environments": { - "type": "array", - "description": "The environments that must be successfully deployed to before branches can be merged.", - "items": { - "type": "string" - } - } - }, - "required": [ - "required_deployment_environments" - ] - } - } + "body": { + "type": "string", + "examples": [ + "# 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" + ] }, - { - "title": "required_signatures", - "description": "Commits pushed to matching refs must have verified signatures.", - "type": "object", - "required": [ - "type" + "html_url": { + "type": [ + "string", + "null" ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_signatures" - ] - } - } + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" }, - { - "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.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "pull_request" - ] - }, - "parameters": { - "type": "object", - "properties": { - "allowed_merge_methods": { - "type": "array", - "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", - "items": { - "type": "string", - "enum": [ - "merge", - "squash", - "rebase" - ] - } - }, - "automatic_copilot_code_review_enabled": { - "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean", - "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." - }, - "require_code_owner_review": { - "type": "boolean", - "description": "Require an approving review in pull requests that modify files that have a designated code owner." - }, - "require_last_push_approval": { - "type": "boolean", - "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." - }, - "required_approving_review_count": { - "type": "integer", - "description": "The number of approving reviews that are required before a pull request can be merged.", - "minimum": 0, - "maximum": 10 - }, - "required_review_thread_resolution": { - "type": "boolean", - "description": "All conversations on code must be resolved before a pull request can be merged." - } - }, - "required": [ - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "require_last_push_approval", - "required_approving_review_count", - "required_review_thread_resolution" - ] - } - } + "name": { + "type": "string" }, - { - "title": "required_status_checks", - "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_status_checks" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "required_status_checks": { - "type": "array", - "description": "Status checks that are required.", - "items": { - "title": "StatusCheckConfiguration", - "description": "Required status check", - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "The status check context name that must be present on the commit." - }, - "integration_id": { - "type": "integer", - "description": "The optional integration ID that this status check must originate from." - } - }, - "required": [ - "context" - ] - } - }, - "strict_required_status_checks_policy": { - "type": "boolean", - "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." - } - }, - "required": [ - "required_status_checks", - "strict_required_status_checks_policy" - ] - } - } + "spdx_id": { + "type": "string" }, - { - "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "non_fast_forward" - ] - } - } + "url": { + "type": "string" }, - { - "title": "commit_message_pattern", - "description": "Parameters to be used for the commit_message_pattern rule", + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "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", - "required": [ - "type" - ], "properties": { - "type": { + "status": { "type": "string", "enum": [ - "commit_message_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" + "enabled", + "disabled" ] } } }, - { - "title": "commit_author_email_pattern", - "description": "Parameters to be used for the commit_author_email_pattern rule", + "code_security": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { + "status": { "type": "string", "enum": [ - "commit_author_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" + "enabled", + "disabled" ] } } }, - { - "title": "committer_email_pattern", - "description": "Parameters to be used for the committer_email_pattern rule", + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", "type": "object", - "required": [ - "type" - ], "properties": { - "type": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", "type": "string", "enum": [ - "committer_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" + "enabled", + "disabled" ] } } }, - { - "title": "branch_name_pattern", - "description": "Parameters to be used for the branch_name_pattern rule", + "secret_scanning": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { + "status": { "type": "string", "enum": [ - "branch_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" + "enabled", + "disabled" ] } } }, - { - "title": "tag_name_pattern", - "description": "Parameters to be used for the tag_name_pattern rule", + "secret_scanning_push_protection": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { + "status": { "type": "string", "enum": [ - "tag_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" + "enabled", + "disabled" ] } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "secret_scanning_non_provider_patterns": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { + "status": { "type": "string", "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" + "enabled", + "disabled" ] } } }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "secret_scanning_ai_detection": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { + "status": { "type": "string", "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" + "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 } }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } + "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, - "name": "super cool ruleset", - "target": "branch", - "source_type": "Organization", - "source": "my-org", - "enforcement": "active", - "bypass_actors": [ - { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" - } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" - ], - "exclude": [ - "refs/heads/dev*" - ] + "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 }, - "repository_name": { - "include": [ - "important_repository", - "another_important_repository" - ], - "exclude": [ - "unimportant_repository" - ], - "protected": true - } - }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } - } - ], - "node_id": "RRS_lACkVXNlcgQB", - "_links": { - "self": { - "href": "https://api.github.com/orgs/my-org/rulesets/21" + "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": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "has_discussions": false, + "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 }, - "html": { - "href": "https://github.com/organizations/my-org/settings/rules/21" + "security_and_analysis": { + "advanced_security": { + "status": "enabled" + }, + "secret_scanning": { + "status": "enabled" + }, + "secret_scanning_push_protection": { + "status": "disabled" + }, + "secret_scanning_non_provider_patterns": { + "status": "disabled" + } } - }, - "created_at": "2023-08-15T08:43:03Z", - "updated_at": "2023-09-23T16:29:47Z" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } + } + ] } } } - } - }, - "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" } } } } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" } - } - }, - "/orgs/{org}/rulesets/rule-suites": { - "get": { - "summary": "List organization rule suites", - "description": "Lists suites of rule evaluations at the organization level.\nFor more information, see \"[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets).\"", + }, + "post": { + "summary": "Create an organization repository", + "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.", "tags": [ "repos" ], - "operationId": "repos/get-org-rule-suites", + "operationId": "repos/create-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites" + "url": "https://docs.github.com/rest/repos/repos#create-an-organization-repository" }, "parameters": [ { @@ -152588,4900 +146883,4810 @@ "schema": { "type": "string" } - }, - { - "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 to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned.", - "in": "query", - "schema": { - "type": "string" - }, - "x-multi-segment": true - }, - { - "name": "repository_name", - "description": "The name of the repository to filter on.", - "in": "query", - "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": "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" - } - }, - { - "name": "rule_suite_result", - "description": "The rule suite results to filter on. When specified, only suites with this result will be returned.", - "in": "query", - "schema": { - "type": "string", - "enum": [ - "pass", - "fail", - "bypass", - "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", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } } ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Rule Suites", - "description": "Response", - "type": "array", - "items": { + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository." + }, + "description": { + "type": "string", + "description": "A short description of the repository." + }, + "homepage": { + "type": "string", + "description": "A URL with more information about the repository." + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private.", + "default": false + }, + "visibility": { + "type": "string", + "description": "The visibility of the repository.", + "enum": [ + "public", + "private" + ] + }, + "has_issues": { + "type": "boolean", + "description": "Either `true` to enable issues for this repository or `false` to disable them.", + "default": true + }, + "has_projects": { + "type": "boolean", + "description": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", + "default": true + }, + "has_wiki": { + "type": "boolean", + "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", + "default": true + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "is_template": { + "type": "boolean", + "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", + "default": false + }, + "team_id": { + "type": "integer", + "description": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization." + }, + "auto_init": { + "type": "boolean", + "description": "Pass `true` to create an initial commit with empty README.", + "default": false + }, + "gitignore_template": { + "type": "string", + "description": "Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, \"Haskell\"." + }, + "license_template": { + "type": "string", + "description": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\"." + }, + "allow_squash_merge": { + "type": "boolean", + "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", + "default": true + }, + "allow_merge_commit": { + "type": "boolean", + "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", + "default": true + }, + "allow_rebase_merge": { + "type": "boolean", + "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", + "default": true + }, + "allow_auto_merge": { + "type": "boolean", + "description": "Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge.", + "default": false + }, + "delete_branch_on_merge": { + "type": "boolean", + "description": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. **The authenticated user must be an organization owner to set this property to `true`.**", + "default": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **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": "Required when using `squash_merge_commit_message`.\n\nThe 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": "Required when using `merge_commit_message`.\n\nThe 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." + }, + "custom_properties": { "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the rule insight." - }, - "actor_id": { - "type": "integer", - "description": "The number that identifies the user." - }, - "actor_name": { - "type": "string", - "description": "The handle for the GitHub user account." - }, - "before_sha": { - "type": "string", - "description": "The first commit sha before the push evaluation." - }, - "after_sha": { - "type": "string", - "description": "The last commit sha in the push evaluation." - }, - "ref": { - "type": "string", - "description": "The ref name that the evaluation ran on." - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository associated with the rule evaluation." - }, - "repository_name": { - "type": "string", - "description": "The name of the repository without the `.git` extension." - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "result": { - "type": "string", - "enum": [ - "pass", - "fail", - "bypass" - ], - "description": "The result of the rule evaluations for rules with the `active` enforcement status." - }, - "evaluation_result": { - "type": "string", - "enum": [ - "pass", - "fail", - "bypass" - ], - "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`." - } - } + "description": "The custom properties for the new repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, - "examples": { - "default": { - "value": [ - { - "id": 21, - "actor_id": 12, - "actor_name": "octocat", - "before_sha": "893f768e172fb1bc9c5d6f3dd48557e45f14e01d", - "after_sha": "dedd88641a362b6b4ea872da4847d6131a164d01", - "ref": "refs/heads/i-see-everything", - "repository_id": 404, - "repository_name": "octo-repo", - "pushed_at": "2023-07-06T08:43:03Z", - "result": "bypass" - }, - { - "id": 25, - "actor_id": 11, - "actor_name": "not-octocat", - "before_sha": "48994e4e01ccc943624c6231f172702b82b233cc", - "after_sha": "ecfd5a1025fa271a33ca5608d089476a2df3c9a1", - "ref": "refs/heads/i-am-everything", - "repository_id": 404, - "repository_name": "octo-repo", - "pushed_at": "2023-07-07T08:43:03Z", - "result": "pass", - "evaluation_result": "fail" - } - ] - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "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" - } + "required": [ + "name" + ] + }, + "examples": { + "default": { + "value": { + "name": "Hello-World", + "description": "This is your first repository", + "homepage": "https://github.com", + "private": false, + "has_issues": true, + "has_projects": true, + "has_wiki": true } } } } } }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "rule-suites" - } - } - }, - "/orgs/{org}/rulesets/rule-suites/{rule_suite_id}": { - "get": { - "summary": "Get an organization rule suite", - "description": "Gets information about a suite of rule evaluations from within an organization.\nFor more information, see \"[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets).\"", - "tags": [ - "repos" - ], - "operationId": "repos/get-org-rule-suite", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "rule_suite_id", - "description": "The unique identifier of the rule suite result.\nTo get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites)\nfor repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites)\nfor organizations.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], "responses": { - "200": { + "201": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Rule Suite", - "description": "Response", + "title": "Full Repository", + "description": "Full Repository", "type": "object", "properties": { "id": { "type": "integer", - "description": "The unique identifier of the rule insight." + "format": "int64", + "examples": [ + 1296269 + ] }, - "actor_id": { - "type": [ - "integer", - "null" - ], - "description": "The number that identifies the user." + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] }, - "actor_name": { + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { "type": [ "string", "null" ], - "description": "The handle for the GitHub user account." + "examples": [ + "This your first repo!" + ] }, - "before_sha": { + "fork": { + "type": "boolean" + }, + "url": { "type": "string", - "description": "The first commit sha before the push evaluation." + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] }, - "after_sha": { + "archive_url": { "type": "string", - "description": "The last commit sha in the push evaluation." + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] }, - "ref": { + "assignees_url": { "type": "string", - "description": "The ref name that the evaluation ran on." + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository associated with the rule evaluation." + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] }, - "repository_name": { + "branches_url": { "type": "string", - "description": "The name of the repository without the `.git` extension." + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] }, - "pushed_at": { + "collaborators_url": { "type": "string", - "format": "date-time", "examples": [ - "2011-01-26T19:06:43Z" + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, - "result": { + "comments_url": { "type": "string", - "enum": [ - "pass", - "fail", - "bypass" - ], - "description": "The result of the rule evaluations for rules with the `active` enforcement status." + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] }, - "evaluation_result": { - "type": [ - "string", - "null" - ], - "enum": [ - "pass", - "fail", - "bypass", - null - ], - "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. Null if no rules with `evaluate` enforcement status were run." + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] }, - "rule_evaluations": { - "type": "array", - "description": "Details on the evaluated rules.", - "items": { - "type": "object", - "properties": { - "rule_source": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of rule source." - }, - "id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the rule source." - }, - "name": { - "type": [ - "string", - "null" - ], - "description": "The name of the rule source." - } - } - }, - "enforcement": { - "type": "string", - "enum": [ - "active", - "evaluate", - "deleted ruleset" - ], - "description": "The enforcement level of this rule source." - }, - "result": { - "type": "string", - "enum": [ - "pass", - "fail" - ], - "description": "The result of the evaluation of the individual rule." - }, - "rule_type": { - "type": "string", - "description": "The type of rule." - }, - "details": { - "type": [ - "string", - "null" - ], - "description": "The detailed failure message for the rule. Null if the rule passed." - } - } - } - } - } - }, - "examples": { - "default": { - "value": { - "id": 21, - "actor_id": 12, - "actor_name": "octocat", - "before_sha": "893f768e172fb1bc9c5d6f3dd48557e45f14e01d", - "after_sha": "dedd88641a362b6b4ea872da4847d6131a164d01", - "ref": "refs/heads/i-see-everything", - "repository_id": 404, - "repository_name": "octo-repo", - "pushed_at": "2023-07-06T08:43:03Z", - "result": "bypass", - "evaluation_result": "fail", - "rule_evaluations": [ - { - "rule_source": { - "type": "ruleset", - "id": 2, - "name": "Author email must be a GitHub email address" - }, - "enforcement": "active", - "result": "pass", - "rule_type": "commit_author_email_pattern" - }, - { - "rule_source": { - "type": "protected_branch" - }, - "enforcement": "active", - "result": "fail", - "rule_type": "pull_request", - "details": "Changes must be made through a pull request." - }, - { - "rule_source": { - "type": "ruleset", - "id": 3, - "name": "Evaluate commit message pattern" - }, - "enforcement": "evaluate", - "result": "fail", - "rule_type": "commit_message_pattern" - } + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" }, - "documentation_url": { - "type": "string" + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] }, - "url": { - "type": "string" + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] }, - "documentation_url": { - "type": "string" + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] }, - "url": { - "type": "string" + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "rule-suites" - } - } - }, - "/orgs/{org}/rulesets/{ruleset_id}": { - "get": { - "summary": "Get an organization repository ruleset", - "description": "Get a repository ruleset for an organization.\n\n**Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user\nmaking the API request has write access to the ruleset.", - "tags": [ - "repos" - ], - "operationId": "repos/get-org-ruleset", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/rules#get-an-organization-repository-ruleset" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "rules" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "ruleset_id", - "description": "The ID of the ruleset.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Repository ruleset", - "type": "object", - "description": "A set of rules to apply when specified conditions are met.", - "required": [ - "id", - "name", - "source", - "enforcement" - ], - "properties": { - "id": { - "type": "integer", - "description": "The ID of the ruleset" + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] }, - "name": { + "git_commits_url": { "type": "string", - "description": "The name of the ruleset" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] }, - "target": { + "git_refs_url": { "type": "string", - "description": "The target of the ruleset", - "enum": [ - "branch", - "tag", - "push", - "repository" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, - "source_type": { + "git_tags_url": { "type": "string", - "description": "The type of the source of the ruleset", - "enum": [ - "Repository", - "Organization", - "Enterprise" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, - "source": { + "git_url": { "type": "string", - "description": "The name of the source" + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] }, - "enforcement": { + "issue_comment_url": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).", - "enum": [ - "disabled", - "active", - "evaluate" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, - "bypass_actors": { + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { "type": "array", - "description": "The actors that can bypass the rules in this ruleset", "items": { - "title": "Repository Ruleset Bypass Actor", - "type": "object", - "description": "An actor that can bypass rules in a ruleset", - "required": [ - "actor_type" - ], - "properties": { - "actor_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." - }, - "actor_type": { - "type": "string", - "enum": [ - "Integration", - "OrganizationAdmin", - "RepositoryRole", - "Team", - "DeployKey" - ], - "description": "The type of actor that can bypass a ruleset." - }, - "bypass_mode": { - "type": "string", - "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", - "enum": [ - "always", - "pull_request" - ], - "default": "always" - } - } - } + "type": "string" + }, + "examples": [ + "octocat", + "atom", + "electron", + "API" + ] }, - "current_user_can_bypass": { + "has_issues": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", "type": "string", - "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", - "enum": [ - "always", - "pull_requests_only", - "never" + "examples": [ + "public" ] }, - "node_id": { - "type": "string" + "pushed_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] }, - "_links": { + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { "type": "object", "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The URL of the ruleset" - } - } + "admin": { + "type": "boolean" }, - "html": { - "type": [ - "object", - "null" - ], - "properties": { - "href": { - "type": "string", - "description": "The html URL of the ruleset" - } - } + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" } - } + }, + "required": [ + "admin", + "pull", + "push" + ] }, - "conditions": { + "allow_rebase_merge": { + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { "anyOf": [ { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } + "type": "null" }, { - "title": "Organization ruleset conditions", + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", - "oneOf": [ - { - "type": "object", - "title": "repository_name_and_ref_name", - "description": "Conditions to target repositories by name and refs by name", - "allOf": [ + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } + "type": "null" }, { - "title": "Repository ruleset conditions for repository names", + "title": "License Simple", + "description": "License Simple", "type": "object", - "description": "Parameters for a repository name condition", "properties": { - "repository_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - }, - "protected": { - "type": "boolean", - "description": "Whether renaming of target repositories is prevented." - } - } + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" } }, "required": [ - "repository_name" + "key", + "name", + "url", + "spdx_id", + "node_id" ] } ] }, - { + "forks": { + "type": "integer" + }, + "permissions": { "type": "object", - "title": "repository_id_and_ref_name", - "description": "Conditions to target repositories by id and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } + "properties": { + "admin": { + "type": "boolean" }, - { - "title": "Repository ruleset conditions for repository IDs", - "type": "object", - "description": "Parameters for a repository ID condition", - "properties": { - "repository_id": { - "type": "object", - "properties": { - "repository_ids": { - "type": "array", - "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", - "items": { - "type": "integer" - } - } - } - } - }, - "required": [ - "repository_id" - ] + "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", - "title": "repository_property_and_ref_name", - "description": "Conditions to target repositories by property and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - { - "title": "Repository ruleset conditions for repository properties", - "type": "object", - "description": "Parameters for a repository property condition", - "properties": { - "repository_property": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - }, - "exclude": { - "type": "array", - "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - } - } - } - }, - "required": [ - "repository_property" + "email": { + "type": [ + "string", + "null" ] - } - ] - } - ] - } - ], - "type": [ - "null", - "object" - ] - }, - "rules": { - "type": "array", - "items": { - "title": "Repository Rule", - "type": "object", - "description": "A repository rule.", - "oneOf": [ - { - "title": "creation", - "description": "Only allow users with bypass permission to create matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "creation" - ] - } - } - }, - { - "title": "update", - "description": "Only allow users with bypass permission to update matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "update" - ] - }, - "parameters": { - "type": "object", - "properties": { - "update_allows_fetch_and_merge": { - "type": "boolean", - "description": "Branch can pull changes from its upstream repository" - } }, - "required": [ - "update_allows_fetch_and_merge" - ] - } - } - }, - { - "title": "deletion", - "description": "Only allow users with bypass permissions to delete matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "deletion" - ] - } - } - }, - { - "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_linear_history" - ] - } - } - }, - { - "title": "merge_queue", - "description": "Merges must be performed via a merge queue.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "merge_queue" - ] - }, - "parameters": { - "type": "object", - "properties": { - "check_response_timeout_minutes": { - "type": "integer", - "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", - "minimum": 1, - "maximum": 360 - }, - "grouping_strategy": { - "type": "string", - "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", - "enum": [ - "ALLGREEN", - "HEADGREEN" - ] - }, - "max_entries_to_build": { - "type": "integer", - "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", - "minimum": 0, - "maximum": 100 - }, - "max_entries_to_merge": { - "type": "integer", - "description": "The maximum number of PRs that will be merged together in a group.", - "minimum": 0, - "maximum": 100 - }, - "merge_method": { - "type": "string", - "description": "Method to use when merging changes from queued pull requests.", - "enum": [ - "MERGE", - "SQUASH", - "REBASE" - ] - }, - "min_entries_to_merge": { - "type": "integer", - "description": "The minimum number of PRs that will be merged together in a group.", - "minimum": 0, - "maximum": 100 - }, - "min_entries_to_merge_wait_minutes": { - "type": "integer", - "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", - "minimum": 0, - "maximum": 360 - } + "login": { + "type": "string", + "examples": [ + "octocat" + ] }, - "required": [ - "check_response_timeout_minutes", - "grouping_strategy", - "max_entries_to_build", - "max_entries_to_merge", - "merge_method", - "min_entries_to_merge", - "min_entries_to_merge_wait_minutes" - ] - } - } - }, - { - "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_deployments" - ] - }, - "parameters": { - "type": "object", - "properties": { - "required_deployment_environments": { - "type": "array", - "description": "The environments that must be successfully deployed to before branches can be merged.", - "items": { - "type": "string" - } - } + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] }, - "required": [ - "required_deployment_environments" - ] - } - } - }, - { - "title": "required_signatures", - "description": "Commits pushed to matching refs must have verified signatures.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_signatures" - ] - } - } - }, - { - "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.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "pull_request" - ] - }, - "parameters": { - "type": "object", - "properties": { - "allowed_merge_methods": { - "type": "array", - "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", - "items": { - "type": "string", - "enum": [ - "merge", - "squash", - "rebase" - ] - } - }, - "automatic_copilot_code_review_enabled": { - "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean", - "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." - }, - "require_code_owner_review": { - "type": "boolean", - "description": "Require an approving review in pull requests that modify files that have a designated code owner." - }, - "require_last_push_approval": { - "type": "boolean", - "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." - }, - "required_approving_review_count": { - "type": "integer", - "description": "The number of approving reviews that are required before a pull request can be merged.", - "minimum": 0, - "maximum": 10 - }, - "required_review_thread_resolution": { - "type": "boolean", - "description": "All conversations on code must be resolved before a pull request can be merged." - } + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] }, - "required": [ - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "require_last_push_approval", - "required_approving_review_count", - "required_review_thread_resolution" - ] - } - } - }, - { - "title": "required_status_checks", - "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_status_checks" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "required_status_checks": { - "type": "array", - "description": "Status checks that are required.", - "items": { - "title": "StatusCheckConfiguration", - "description": "Required status check", - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "The status check context name that must be present on the commit." - }, - "integration_id": { - "type": "integer", - "description": "The optional integration ID that this status check must originate from." - } - }, - "required": [ - "context" - ] - } - }, - "strict_required_status_checks_policy": { - "type": "boolean", - "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." - } + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, - "required": [ - "required_status_checks", - "strict_required_status_checks_policy" - ] - } - } - }, - { - "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "non_fast_forward" - ] - } - } - }, - { - "title": "commit_message_pattern", - "description": "Parameters to be used for the commit_message_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_message_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "commit_author_email_pattern", - "description": "Parameters to be used for the commit_author_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_author_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "committer_email_pattern", - "description": "Parameters to be used for the committer_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "committer_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "branch_name_pattern", - "description": "Parameters to be used for the branch_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "branch_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "tag_name_pattern", - "description": "Parameters to be used for the tag_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tag_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] }, - "required": [ - "max_file_size" - ] - } - } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] }, - "required": [ - "code_scanning_tools" - ] - } - } - } - ] - } - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - }, - "examples": { - "default": { - "value": { - "id": 21, - "name": "super cool ruleset", - "target": "branch", - "source_type": "Organization", - "source": "my-org", - "enforcement": "active", - "bypass_actors": [ - { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" - } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" - ], - "exclude": [ - "refs/heads/dev*" - ] - }, - "repository_name": { - "include": [ - "important_repository", - "another_important_repository" - ], - "exclude": [ - "unimportant_repository" - ], - "protected": true - } - }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } - } - ], - "node_id": "RRS_lACkVXNlcgQB", - "_links": { - "self": { - "href": "https://api.github.com/orgs/my-org/rulesets/21" - }, - "html": { - "href": "https://github.com/organizations/my-org/settings/rules/21" - } - }, - "created_at": "2023-08-15T08:43:03Z", - "updated_at": "2023-09-23T16:29:47Z" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "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" - } - } - } - } - } - } - } - }, - "put": { - "summary": "Update an organization repository ruleset", - "description": "Update a ruleset for an organization.", - "tags": [ - "repos" - ], - "operationId": "repos/update-org-ruleset", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/rules#update-an-organization-repository-ruleset" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "rules" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "ruleset_id", - "description": "The ID of the ruleset.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "description": "Request body", - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the ruleset." - }, - "target": { - "type": "string", - "description": "The target of the ruleset", - "enum": [ - "branch", - "tag", - "push", - "repository" - ] - }, - "enforcement": { - "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).", - "enum": [ - "disabled", - "active", - "evaluate" - ] - }, - "bypass_actors": { - "type": "array", - "description": "The actors that can bypass the rules in this ruleset", - "items": { - "title": "Repository Ruleset Bypass Actor", - "type": "object", - "description": "An actor that can bypass rules in a ruleset", - "required": [ - "actor_type" - ], - "properties": { - "actor_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." - }, - "actor_type": { - "type": "string", - "enum": [ - "Integration", - "OrganizationAdmin", - "RepositoryRole", - "Team", - "DeployKey" - ], - "description": "The type of actor that can bypass a ruleset." - }, - "bypass_mode": { - "type": "string", - "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", - "enum": [ - "always", - "pull_request" - ], - "default": "always" - } - } - } - }, - "conditions": { - "title": "Organization ruleset conditions", - "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", - "oneOf": [ - { - "type": "object", - "title": "repository_name_and_ref_name", - "description": "Conditions to target repositories by name and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository names", - "type": "object", - "description": "Parameters for a repository name condition", - "properties": { - "repository_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - }, - "protected": { - "type": "boolean", - "description": "Whether renaming of target repositories is prevented." - } - } - } - }, - "required": [ - "repository_name" - ] - } - ] - }, - { - "type": "object", - "title": "repository_id_and_ref_name", - "description": "Conditions to target repositories by id and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository IDs", - "type": "object", - "description": "Parameters for a repository ID condition", - "properties": { - "repository_id": { - "type": "object", - "properties": { - "repository_ids": { - "type": "array", - "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", - "items": { - "type": "integer" - } - } + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, - "required": [ - "repository_id" - ] - } - ] - }, - { - "type": "object", - "title": "repository_property_and_ref_name", - "description": "Conditions to target repositories by property and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository properties", - "type": "object", - "description": "Parameters for a repository property condition", - "properties": { - "repository_property": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - }, - "exclude": { - "type": "array", - "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - } - } - } + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" }, - "required": [ - "repository_property" - ] - } - ] - } - ] - }, - "rules": { - "description": "An array of rules within the ruleset.", - "type": "array", - "items": { - "title": "Repository Rule", - "type": "object", - "description": "A repository rule.", - "oneOf": [ - { - "title": "creation", - "description": "Only allow users with bypass permission to create matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + "html_url": { "type": "string", - "enum": [ - "creation" + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" ] - } - } - }, - { - "title": "update", - "description": "Only allow users with bypass permission to update matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { "type": "string", - "enum": [ - "update" + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" ] }, - "parameters": { - "type": "object", - "properties": { - "update_allows_fetch_and_merge": { - "type": "boolean", - "description": "Branch can pull changes from its upstream repository" - } - }, - "required": [ - "update_allows_fetch_and_merge" + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] - } - } - }, - { - "title": "deletion", - "description": "Only allow users with bypass permissions to delete matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "assignees_url": { "type": "string", - "enum": [ - "deletion" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] - } - } - }, - { - "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "blobs_url": { "type": "string", - "enum": [ - "required_linear_history" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] - } - } - }, - { - "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "branches_url": { "type": "string", - "enum": [ - "required_deployments" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, - "parameters": { - "type": "object", - "properties": { - "required_deployment_environments": { - "type": "array", - "description": "The environments that must be successfully deployed to before branches can be merged.", - "items": { - "type": "string" - } - } - }, - "required": [ - "required_deployment_environments" + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] - } - } - }, - { - "title": "required_signatures", - "description": "Commits pushed to matching refs must have verified signatures.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "comments_url": { "type": "string", - "enum": [ - "required_signatures" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] - } - } - }, - { - "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.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "commits_url": { "type": "string", - "enum": [ - "pull_request" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, - "parameters": { - "type": "object", - "properties": { - "allowed_merge_methods": { - "type": "array", - "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", - "items": { - "type": "string", - "enum": [ - "merge", - "squash", - "rebase" - ] - } - }, - "automatic_copilot_code_review_enabled": { - "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean", - "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." - }, - "require_code_owner_review": { - "type": "boolean", - "description": "Require an approving review in pull requests that modify files that have a designated code owner." - }, - "require_last_push_approval": { - "type": "boolean", - "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." - }, - "required_approving_review_count": { - "type": "integer", - "description": "The number of approving reviews that are required before a pull request can be merged.", - "minimum": 0, - "maximum": 10 - }, - "required_review_thread_resolution": { - "type": "boolean", - "description": "All conversations on code must be resolved before a pull request can be merged." - } - }, - "required": [ - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "require_last_push_approval", - "required_approving_review_count", - "required_review_thread_resolution" + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] - } - } - }, - { - "title": "required_status_checks", - "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "contents_url": { "type": "string", - "enum": [ - "required_status_checks" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "required_status_checks": { - "type": "array", - "description": "Status checks that are required.", - "items": { - "title": "StatusCheckConfiguration", - "description": "Required status check", - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "The status check context name that must be present on the commit." - }, - "integration_id": { - "type": "integer", - "description": "The optional integration ID that this status check must originate from." - } - }, - "required": [ - "context" - ] - } - }, - "strict_required_status_checks_policy": { - "type": "boolean", - "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." - } - }, - "required": [ - "required_status_checks", - "strict_required_status_checks_policy" + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" ] - } - } - }, - { - "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "deployments_url": { "type": "string", - "enum": [ - "non_fast_forward" + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" ] - } - } - }, - { - "title": "commit_message_pattern", - "description": "Parameters to be used for the commit_message_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "downloads_url": { "type": "string", - "enum": [ - "commit_message_pattern" + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" ] - } - } - }, - { - "title": "commit_author_email_pattern", - "description": "Parameters to be used for the commit_author_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "forks_url": { "type": "string", - "enum": [ - "commit_author_email_pattern" + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" ] }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] - } - } - }, - { - "title": "committer_email_pattern", - "description": "Parameters to be used for the committer_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "git_refs_url": { "type": "string", - "enum": [ - "committer_email_pattern" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] - } - } - }, - { - "title": "branch_name_pattern", - "description": "Parameters to be used for the branch_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "git_url": { "type": "string", - "enum": [ - "branch_name_pattern" + "examples": [ + "git:github.com/octocat/Hello-World.git" ] }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] - } - } - }, - { - "title": "tag_name_pattern", - "description": "Parameters to be used for the tag_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "issue_events_url": { "type": "string", - "enum": [ - "tag_name_pattern" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] - } - } - }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "keys_url": { "type": "string", - "enum": [ - "file_path_restriction" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "languages_url": { "type": "string", - "enum": [ - "max_file_path_length" + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" ] }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "milestones_url": { "type": "string", - "enum": [ - "file_extension_restriction" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "pulls_url": { "type": "string", - "enum": [ - "max_file_size" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] - } - } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "ssh_url": { "type": "string", - "enum": [ - "workflows" + "examples": [ + "git@github.com:octocat/Hello-World.git" ] }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { "type": "string", "enum": [ - "code_scanning" + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true ] }, - "parameters": { + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { "type": "object", + "description": "The status of the code search index for this repository", "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" } - }, - "required": [ - "code_scanning_tools" - ] + } } - } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] } ] - } - } - } - }, - "examples": { - "default": { - "value": { - "name": "super cool ruleset", - "target": "branch", - "enforcement": "active", - "bypass_actors": [ - { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" - } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" - ], - "exclude": [ - "refs/heads/dev*" - ] - }, - "repository_name": { - "include": [ - "important_repository", - "another_important_repository" - ], - "exclude": [ - "unimportant_repository" - ], - "protected": true - } }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Repository ruleset", - "type": "object", - "description": "A set of rules to apply when specified conditions are met.", - "required": [ - "id", - "name", - "source", - "enforcement" - ], - "properties": { - "id": { - "type": "integer", - "description": "The ID of the ruleset" + "temp_clone_token": { + "type": [ + "string", + "null" + ] }, - "name": { - "type": "string", - "description": "The name of the ruleset" + "allow_squash_merge": { + "type": "boolean", + "examples": [ + true + ] }, - "target": { + "allow_auto_merge": { + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "type": "boolean", + "examples": [ + false + ] + }, + "allow_merge_commit": { + "type": "boolean", + "examples": [ + true + ] + }, + "allow_update_branch": { + "type": "boolean", + "examples": [ + true + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "examples": [ + false + ] + }, + "squash_merge_commit_title": { "type": "string", - "description": "The target of the ruleset", "enum": [ - "branch", - "tag", - "push", - "repository" + "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).", + "examples": [ + "PR_TITLE" ] }, - "source_type": { + "squash_merge_commit_message": { "type": "string", - "description": "The type of the source of the ruleset", "enum": [ - "Repository", - "Organization", - "Enterprise" + "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.", + "examples": [ + "PR_BODY" ] }, - "source": { + "merge_commit_title": { "type": "string", - "description": "The name of the source" + "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).", + "examples": [ + "PR_TITLE" + ] }, - "enforcement": { + "merge_commit_message": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).", "enum": [ - "disabled", - "active", - "evaluate" + "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.", + "examples": [ + "PR_BODY" ] }, - "bypass_actors": { - "type": "array", - "description": "The actors that can bypass the rules in this ruleset", - "items": { - "title": "Repository Ruleset Bypass Actor", - "type": "object", - "description": "An actor that can bypass rules in a ruleset", - "required": [ - "actor_type" - ], - "properties": { - "actor_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." - }, - "actor_type": { - "type": "string", - "enum": [ - "Integration", - "OrganizationAdmin", - "RepositoryRole", - "Team", - "DeployKey" - ], - "description": "The type of actor that can bypass a ruleset." - }, - "bypass_mode": { - "type": "string", - "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", - "enum": [ - "always", - "pull_request" - ], - "default": "always" - } - } - } + "allow_forking": { + "type": "boolean", + "examples": [ + true + ] }, - "current_user_can_bypass": { - "type": "string", - "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", - "enum": [ - "always", - "pull_requests_only", - "never" + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false ] }, - "node_id": { - "type": "string" + "subscribers_count": { + "type": "integer", + "examples": [ + 42 + ] }, - "_links": { - "type": "object", - "properties": { - "self": { + "network_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", "type": "object", "properties": { - "href": { + "key": { "type": "string", - "description": "The URL of the ruleset" - } - } - }, - "html": { - "type": [ - "object", - "null" - ], - "properties": { - "href": { + "examples": [ + "mit" + ] + }, + "name": { "type": "string", - "description": "The html URL of the ruleset" + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" } - } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] } - } + ] }, - "conditions": { + "organization": { "anyOf": [ { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } + "type": "null" }, { - "title": "Organization ruleset conditions", + "title": "Simple User", + "description": "A GitHub user.", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", - "oneOf": [ - { - "type": "object", - "title": "repository_name_and_ref_name", - "description": "Conditions to target repositories by name and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository names", - "type": "object", - "description": "Parameters for a repository name condition", - "properties": { - "repository_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - }, - "protected": { - "type": "boolean", - "description": "Whether renaming of target repositories is prevented." - } - } - } - }, - "required": [ - "repository_name" - ] - } + "properties": { + "name": { + "type": [ + "string", + "null" ] }, - { - "type": "object", - "title": "repository_id_and_ref_name", - "description": "Conditions to target repositories by id and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository IDs", - "type": "object", - "description": "Parameters for a repository ID condition", - "properties": { - "repository_id": { - "type": "object", - "properties": { - "repository_ids": { - "type": "array", - "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", - "items": { - "type": "integer" - } - } - } - } - }, - "required": [ - "repository_id" - ] - } + "email": { + "type": [ + "string", + "null" ] }, - { - "type": "object", - "title": "repository_property_and_ref_name", - "description": "Conditions to target repositories by property and refs by name", - "allOf": [ - { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - { - "title": "Repository ruleset conditions for repository properties", - "type": "object", - "description": "Parameters for a repository property condition", - "properties": { - "repository_property": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - }, - "exclude": { - "type": "array", - "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", - "items": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" - ] - } - }, - "required": [ - "name", - "property_values" - ] - } - } - } - } - }, - "required": [ - "repository_property" - ] - } + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] } - ], - "type": [ - "null", - "object" ] }, - "rules": { - "type": "array", - "items": { - "title": "Repository Rule", - "type": "object", - "description": "A repository rule.", - "oneOf": [ - { - "title": "creation", - "description": "Only allow users with bypass permission to create matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "creation" - ] - } - } - }, - { - "title": "update", - "description": "Only allow users with bypass permission to update matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "update" - ] - }, - "parameters": { - "type": "object", - "properties": { - "update_allows_fetch_and_merge": { - "type": "boolean", - "description": "Branch can pull changes from its upstream repository" - } + "parent": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] }, - "required": [ - "update_allows_fetch_and_merge" - ] - } - } - }, - { - "title": "deletion", - "description": "Only allow users with bypass permissions to delete matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "deletion" - ] - } - } - }, - { - "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_linear_history" - ] - } - } - }, - { - "title": "merge_queue", - "description": "Merges must be performed via a merge queue.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "merge_queue" - ] - }, - "parameters": { - "type": "object", - "properties": { - "check_response_timeout_minutes": { - "type": "integer", - "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", - "minimum": 1, - "maximum": 360 - }, - "grouping_strategy": { - "type": "string", - "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", - "enum": [ - "ALLGREEN", - "HEADGREEN" - ] - }, - "max_entries_to_build": { - "type": "integer", - "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", - "minimum": 0, - "maximum": 100 - }, - "max_entries_to_merge": { - "type": "integer", - "description": "The maximum number of PRs that will be merged together in a group.", - "minimum": 0, - "maximum": 100 - }, - "merge_method": { - "type": "string", - "description": "Method to use when merging changes from queued pull requests.", - "enum": [ - "MERGE", - "SQUASH", - "REBASE" - ] - }, - "min_entries_to_merge": { - "type": "integer", - "description": "The minimum number of PRs that will be merged together in a group.", - "minimum": 0, - "maximum": 100 - }, - "min_entries_to_merge_wait_minutes": { - "type": "integer", - "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", - "minimum": 0, - "maximum": 360 - } + "name": { + "type": "string", + "examples": [ + "MIT License" + ] }, - "required": [ - "check_response_timeout_minutes", - "grouping_strategy", - "max_entries_to_build", - "max_entries_to_merge", - "merge_method", - "min_entries_to_merge", - "min_entries_to_merge_wait_minutes" - ] - } - } - }, - { - "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_deployments" - ] - }, - "parameters": { - "type": "object", - "properties": { - "required_deployment_environments": { - "type": "array", - "description": "The environments that must be successfully deployed to before branches can be merged.", - "items": { - "type": "string" - } - } + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] }, - "required": [ - "required_deployment_environments" - ] - } - } - }, - { - "title": "required_signatures", - "description": "Commits pushed to matching refs must have verified signatures.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_signatures" - ] - } - } - }, - { - "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.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "pull_request" - ] - }, - "parameters": { - "type": "object", - "properties": { - "allowed_merge_methods": { - "type": "array", - "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", - "items": { - "type": "string", - "enum": [ - "merge", - "squash", - "rebase" - ] - } - }, - "automatic_copilot_code_review_enabled": { - "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean", - "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." - }, - "require_code_owner_review": { - "type": "boolean", - "description": "Require an approving review in pull requests that modify files that have a designated code owner." - }, - "require_last_push_approval": { - "type": "boolean", - "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." - }, - "required_approving_review_count": { - "type": "integer", - "description": "The number of approving reviews that are required before a pull request can be merged.", - "minimum": 0, - "maximum": 10 - }, - "required_review_thread_resolution": { - "type": "boolean", - "description": "All conversations on code must be resolved before a pull request can be merged." - } + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] }, - "required": [ - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "require_last_push_approval", - "required_approving_review_count", - "required_review_thread_resolution" - ] - } - } - }, - { - "title": "required_status_checks", - "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_status_checks" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "required_status_checks": { - "type": "array", - "description": "Status checks that are required.", - "items": { - "title": "StatusCheckConfiguration", - "description": "Required status check", - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "The status check context name that must be present on the commit." - }, - "integration_id": { - "type": "integer", - "description": "The optional integration ID that this status check must originate from." - } - }, - "required": [ - "context" - ] - } - }, - "strict_required_status_checks_policy": { - "type": "boolean", - "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." - } + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] }, - "required": [ - "required_status_checks", - "strict_required_status_checks_policy" - ] - } - } - }, - { - "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "non_fast_forward" - ] - } - } - }, - { - "title": "commit_message_pattern", - "description": "Parameters to be used for the commit_message_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_message_pattern" - ] + "html_url": { + "type": "string", + "format": "uri" + } }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" } }, - { - "title": "commit_author_email_pattern", - "description": "Parameters to be used for the commit_author_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_author_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "committer_email_pattern", - "description": "Parameters to be used for the committer_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "committer_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "branch_name_pattern", - "description": "Parameters to be used for the branch_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "branch_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "tag_name_pattern", - "description": "Parameters to be used for the tag_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tag_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - } - ] - } - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - }, - "examples": { - "default": { - "value": { - "id": 21, - "name": "super cool ruleset", - "target": "branch", - "source_type": "Organization", - "source": "my-org", - "enforcement": "active", - "bypass_actors": [ - { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" - } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" ], - "exclude": [ - "refs/heads/dev*" + "examples": [ + "This your first repo!" ] }, - "repository_name": { - "include": [ - "important_repository", - "another_important_repository" + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" ], - "exclude": [ - "unimportant_repository" + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" ], - "protected": true - } - }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } - } - ], - "node_id": "RRS_lACkVXNlcgQB", - "_links": { - "self": { - "href": "https://api.github.com/orgs/my-org/rulesets/21" + "format": "uri", + "examples": [ + "https://github.com" + ] }, - "html": { - "href": "https://github.com/organizations/my-org/settings/rules/21" - } - }, - "created_at": "2023-08-15T08:43:03Z", - "updated_at": "2023-09-23T16:29:47Z" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "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" - } - } - } - } - } - } - } - }, - "delete": { - "summary": "Delete an organization repository ruleset", - "description": "Delete a ruleset for an organization.", - "tags": [ - "repos" - ], - "operationId": "repos/delete-org-ruleset", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/rules#delete-an-organization-repository-ruleset" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "rules" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "ruleset_id", - "description": "The ID of the ruleset.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "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" - } - } - } - } - } - }, - "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" - } - } - } - } - } - } - } - } - }, - "/orgs/{org}/rulesets/{ruleset_id}/history": { - "get": { - "summary": "Get organization ruleset history", - "description": "Get the history of an organization ruleset.", - "tags": [ - "orgs" - ], - "operationId": "orgs/get-org-ruleset-history", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/rules#get-organization-ruleset-history" - }, - "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": "ruleset_id", - "description": "The ID of the ruleset.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Ruleset version", - "type": "object", - "description": "The historical version of a ruleset", - "required": [ - "version_id", - "actor", - "updated_at" - ], - "properties": { - "version_id": { - "type": "integer", - "description": "The ID of the previous version of the ruleset" - }, - "actor": { - "type": "object", - "description": "The actor who updated the ruleset", - "properties": { - "id": { - "type": "integer" - }, - "type": { + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { "type": "string" } - } - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - } - }, - "examples": { - "default": { - "value": [ - { - "version_id": 3, - "actor": { - "id": 1, - "type": "User" }, - "updated_at": "2024-010-23T16:29:47Z" - }, - { - "version_id": 2, - "actor": { - "id": 2, - "type": "User" + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, - "updated_at": "2024-09-23T16:29:47Z" - }, - { - "version_id": 1, - "actor": { - "id": 1, - "type": "User" + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, - "updated_at": "2024-08-23T16:29:47Z" - } - ] - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "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": true, - "category": "orgs", - "subcategory": "rules" - } - } - }, - "/orgs/{org}/rulesets/{ruleset_id}/history/{version_id}": { - "get": { - "summary": "Get organization ruleset version", - "description": "Get a version of an organization ruleset.", - "tags": [ - "orgs" - ], - "operationId": "orgs/get-org-ruleset-version", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/rules#get-organization-ruleset-version" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "ruleset_id", - "description": "The ID of the ruleset.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "version_id", - "description": "The ID of the version", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "title": "Ruleset version", - "type": "object", - "description": "The historical version of a ruleset", - "required": [ - "version_id", - "actor", - "updated_at" - ], - "properties": { - "version_id": { - "type": "integer", - "description": "The ID of the previous version of the ruleset" + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, - "actor": { + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { "type": "object", - "description": "The actor who updated the ruleset", + "description": "The status of the code search index for this repository", "properties": { - "id": { - "type": "integer" + "lexical_search_ok": { + "type": "boolean" }, - "type": { + "lexical_commit_sha": { "type": "string" } } - }, - "updated_at": { - "type": "string", - "format": "date-time" } - } + }, + "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" + ] }, - { + "source": { + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", - "required": [ - "state" - ], "properties": { - "state": { - "type": "object", - "description": "The state of the ruleset version" - } - } - } - ] - }, - "examples": { - "default": { - "value": [ - { - "version_id": 3, - "actor": { - "id": 1, - "type": "User" + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] }, - "updated_at": "2024-010-23T16:29:47Z", - "state": { - "id": 21, - "name": "super cool ruleset", - "target": "branch", - "source_type": "Organization", - "source": "my-org", - "enforcement": "active", - "bypass_actors": [ + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ { - "actor_id": 234, - "actor_type": "Team", - "bypass_mode": "always" + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] } - ], - "conditions": { - "ref_name": { - "include": [ - "refs/heads/main", - "refs/heads/master" - ], - "exclude": [ - "refs/heads/dev*" + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" ] }, - "repository_name": { - "include": [ - "important_repository", - "another_important_repository" - ], - "exclude": [ - "unimportant_repository" + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" ], - "protected": true + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } }, - "rules": [ - { - "type": "commit_author_email_pattern", - "parameters": { - "operator": "contains", - "pattern": "github" - } - } + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] - } - } - ] - } + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "forks": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "anonymous_access_enabled": { + "description": "Whether anonymous git access is allowed.", + "default": true, + "type": "boolean" + }, + "code_of_conduct": { + "title": "Code Of Conduct Simple", + "description": "Code of Conduct Simple", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/github/docs/community/code_of_conduct" + ] + }, + "key": { + "type": "string", + "examples": [ + "citizen_code_of_conduct" + ] + }, + "name": { + "type": "string", + "examples": [ + "Citizen Code of Conduct" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md" + ] + } + }, + "required": [ + "url", + "key", + "name", + "html_url" + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "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", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "has_discussions", + "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", + "network_count", + "subscribers_count" + ] + }, + "examples": { + "default": { + "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}", + "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", + "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" + }, + "language": null, + "forks_count": 9, + "forks": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "open_issues": 0, + "is_template": false, + "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": { + "pull": true, + "push": false, + "admin": false + }, + "allow_rebase_merge": true, + "template_repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World-Template", + "full_name": "octocat/Hello-World-Template", + "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-Template", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World-Template", + "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World-Template.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World-Template.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World-Template.git", + "mirror_url": "git:git.example.com/octocat/Hello-World-Template", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World-Template", + "homepage": "https://github.com", + "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, + "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", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "allow_forking": true, + "web_commit_signoff_required": false, + "subscribers_count": 42, + "network_count": 0, + "organization": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "Organization", + "site_admin": false + }, + "parent": { + "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, + "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://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + }, + "source": { + "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, + "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://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + } + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World", + "schema": { + "type": "string" } } } }, - "404": { - "description": "Resource not found", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -157506,14 +151711,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" @@ -157521,11 +151730,56 @@ "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } } } } @@ -157536,22 +151790,28 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "rules" + "category": "repos", + "subcategory": "repos" } } }, - "/orgs/{org}/secret-scanning/alerts": { + "/orgs/{org}/rulesets": { "get": { - "summary": "List secret scanning alerts for an organization", - "description": "Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.\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 `repo` or `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": "Get all organization repository rulesets", + "description": "Get all the repository rulesets for an organization.", "tags": [ - "secret-scanning" + "repos" ], - "operationId": "secret-scanning/list-alerts-for-org", + "operationId": "repos/get-org-rulesets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization" + "url": "https://docs.github.com/rest/orgs/rules#get-all-organization-repository-rulesets" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "rules" }, "parameters": [ { @@ -157563,74 +151823,6 @@ "type": "string" } }, - { - "name": "state", - "in": "query", - "description": "Set to `open` or `resolved` to only list secret scanning alerts in a specific state.", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "resolved" - ] - } - }, - { - "name": "secret_type", - "in": "query", - "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "resolution", - "in": "query", - "description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.", - "required": false, - "schema": { - "type": "string" - } - }, - { - "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.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated" - ], - "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": "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).\"", @@ -157641,60 +151833,24 @@ } }, { - "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 receive an initial cursor on your first request, include an empty \"before\" query string.", - "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 events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "validity", - "in": "query", - "description": "A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`.", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "is_publicly_leaked", - "in": "query", - "description": "A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present.", - "required": false, - "schema": { - "type": "boolean", - "default": false - } - }, - { - "name": "is_multi_repo", + "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": "A boolean value representing whether or not to filter alerts by the multi-repo tag being present.", - "required": false, "schema": { - "type": "boolean", - "default": false + "type": "integer", + "default": 1 } }, { - "name": "hide_secret", + "name": "targets", + "description": "A comma-separated list of rule targets to filter by.\nIf provided, only rulesets that apply to the specified targets will be returned.\nFor example, `branch,tag,push`.\n", "in": "query", - "description": "A boolean value representing whether or not to hide literal secrets in the results.", "required": false, "schema": { - "type": "boolean", - "default": false + "type": "string", + "examples": [ + "branch,tag,push" + ] } } ], @@ -157706,1851 +151862,1295 @@ "schema": { "type": "array", "items": { + "title": "Repository ruleset", "type": "object", + "description": "A set of rules to apply when specified conditions are met.", + "required": [ + "id", + "name", + "source", + "enforcement" + ], "properties": { - "number": { + "id": { "type": "integer", - "description": "The security alert number.", - "readOnly": true + "description": "The ID of the ruleset" }, - "created_at": { + "name": { "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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 - } - ] + "description": "The name of the ruleset" }, - "url": { + "target": { "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true + "description": "The target of the ruleset", + "enum": [ + "branch", + "tag", + "push", + "repository" + ] }, - "html_url": { + "source_type": { "type": "string", - "description": "The GitHub URL of the alert resource.", - "format": "uri", - "readOnly": true + "description": "The type of the source of the ruleset", + "enum": [ + "Repository", + "Organization", + "Enterprise" + ] }, - "locations_url": { + "source": { "type": "string", - "format": "uri", - "description": "The REST API URL of the code locations for this alert." + "description": "The name of the source" }, - "state": { - "description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.", + "enforcement": { "type": "string", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).", "enum": [ - "open", - "resolved" + "disabled", + "active", + "evaluate" ] }, - "resolution": { - "type": [ - "string", - "null" - ], - "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "title": "Repository Ruleset Bypass Actor", + "type": "object", + "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_type" + ], + "properties": { + "actor_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + }, + "actor_type": { + "type": "string", + "enum": [ + "Integration", + "OrganizationAdmin", + "RepositoryRole", + "Team", + "DeployKey" + ], + "description": "The type of actor that can bypass a ruleset." + }, + "bypass_mode": { + "type": "string", + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", + "enum": [ + "always", + "pull_request" + ], + "default": "always" + } + } + } + }, + "current_user_can_bypass": { + "type": "string", + "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", "enum": [ - "false_positive", - "wont_fix", - "revoked", - "used_in_tests", - null + "always", + "pull_requests_only", + "never" ] }, - "resolved_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + "node_id": { + "type": "string" }, - "resolved_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", + "_links": { + "type": "object", + "properties": { + "self": { "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { + "href": { "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { + "description": "The URL of the ruleset" + } + } + }, + "html": { + "type": [ + "object", + "null" + ], + "properties": { + "href": { "type": "string", - "examples": [ - "public" - ] + "description": "The html URL of the ruleset" } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + } } - ] - }, - "secret_type": { - "type": "string", - "description": "The type of secret that secret scanning detected." - }, - "secret_type_display_name": { - "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" - }, - "secret": { - "type": "string", - "description": "The secret that was detected." + } }, - "repository": { - "title": "Simple Repository", - "description": "A GitHub repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "A unique identifier of the repository.", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "description": "The GraphQL identifier of the repository.", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "description": "The name of the repository.", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "description": "The full, globally unique, name of the repository.", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", + "conditions": { + "anyOf": [ + { + "title": "Repository ruleset conditions for ref names", "type": "object", + "description": "Parameters for a repository ruleset ref name condition", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean", - "description": "Whether the repository is private." - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL to view the repository on GitHub.com.", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The repository description.", - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL to get more information about the repository from the GitHub API.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "description": "A template for the API URL to download the repository as an archive.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "description": "A template for the API URL to list the available assignees for issues in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "description": "A template for the API URL to get information about branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "description": "A template for the API URL to get information about collaborators of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "description": "A template for the API URL to get information about comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "description": "A template for the API URL to get information about commits on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "description": "A template for the API URL to compare two commits or refs.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "description": "A template for the API URL to get the contents of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "description": "A template for the API URL to list the contributors to the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the deployments of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the downloads on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the events of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the forks of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "description": "A template for the API URL to get information about Git commits of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "description": "A template for the API URL to get information about Git refs of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "description": "A template for the API URL to get information about Git tags of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "issue_comment_url": { - "type": "string", - "description": "A template for the API URL to get information about issue comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "description": "A template for the API URL to get information about issue events on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "description": "A template for the API URL to get information about issues on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "description": "A template for the API URL to get information about deploy keys on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "description": "A template for the API URL to get information about labels of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about the languages of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "description": "The API URL to merge branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "description": "A template for the API URL to get information about milestones of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "description": "A template for the API URL to get information about notifications on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "description": "A template for the API URL to get information about pull requests on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "description": "A template for the API URL to get information about releases on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the stargazers on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "description": "A template for the API URL to get information about statuses of a commit.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the subscribers on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "description": "The API URL to subscribe to notifications for this repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about tags on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the teams on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the hooks on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks" - ] - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" - ] - }, - "push_protection_bypassed": { - "type": [ - "boolean", - "null" - ], - "description": "Whether push protection was bypassed for the detected secret." - }, - "push_protection_bypassed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "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" - ] - } - ] - }, - "push_protection_bypassed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." - }, - "push_protection_bypass_request_reviewer": { - "anyOf": [ - { - "type": "null" + } }, { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Organization ruleset conditions", "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "push_protection_bypass_request_reviewer_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment when reviewing a push protection bypass." - }, - "push_protection_bypass_request_comment": { - "type": [ - "string", - "null" - ], - "description": "An optional comment when requesting a push protection bypass." - }, - "push_protection_bypass_request_html_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "description": "The URL to a push protection bypass request." - }, - "resolution_comment": { - "type": [ - "string", - "null" - ], - "description": "The comment that was optionally added when this alert was closed" - }, - "validity": { - "type": "string", - "description": "The token status as of the latest validity check.", - "enum": [ - "active", - "inactive", - "unknown" - ] - }, - "publicly_leaked": { - "type": [ - "boolean", - "null" - ], - "description": "Whether the secret was publicly leaked." - }, - "multi_repo": { - "type": [ - "boolean", - "null" - ], - "description": "Whether the detected secret was found in multiple repositories in the same organization or enterprise." - }, - "is_base64_encoded": { - "type": [ - "boolean", - "null" - ], - "description": "A boolean value representing whether or not alert is base64 encoded" - }, - "first_location_detected": { - "anyOf": [ - { - "type": "null" - }, - { - "description": "Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request.\n", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { - "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path in the repository", - "examples": [ - "/example/secrets.txt" - ] - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "examples": [ - "af5626b4a114abcb82d63db7c8082c3c4756e51b" - ] - }, - "blob_url": { - "type": "string", - "description": "The API URL to get the associated blob resource" + "title": "repository_name_and_ref_name", + "description": "Conditions to target repositories by name and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "examples": [ - "af5626b4a114abcb82d63db7c8082c3c4756e51b" + { + "title": "Repository ruleset conditions for repository names", + "type": "object", + "description": "Parameters for a repository name condition", + "properties": { + "repository_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + }, + "protected": { + "type": "boolean", + "description": "Whether renaming of target repositories is prevented." + } + } + } + }, + "required": [ + "repository_name" ] - }, - "commit_url": { - "type": "string", - "description": "The API URL to get the associated commit resource" } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "blob_url", - "commit_sha", - "commit_url" ] }, { - "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.", "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path of the wiki page", - "examples": [ - "/example/Home.md" - ] - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "examples": [ - "af5626b4a114abcb82d63db7c8082c3c4756e51b" - ] - }, - "page_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki page", - "examples": [ - "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - ] - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "examples": [ - "302c0b7e200761c9dd9b57e57db540ee0b4293a5" - ] + "title": "repository_id_and_ref_name", + "description": "Conditions to target repositories by id and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } }, - "commit_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki commit", - "examples": [ - "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + { + "title": "Repository ruleset conditions for repository IDs", + "type": "object", + "description": "Parameters for a repository ID condition", + "properties": { + "repository_id": { + "type": "object", + "properties": { + "repository_ids": { + "type": "array", + "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" + } + } + } + } + }, + "required": [ + "repository_id" ] } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "page_url", - "commit_sha", - "commit_url" ] }, { - "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", "type": "object", - "properties": { - "issue_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/1347" + "title": "repository_property_and_ref_name", + "description": "Conditions to target repositories by property and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Repository ruleset conditions for repository properties", + "type": "object", + "description": "Parameters for a repository property condition", + "properties": { + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + } + } + } + }, + "required": [ + "repository_property" ] } - }, - "required": [ - "issue_title_url" ] - }, - { - "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", - "type": "object", - "properties": { - "issue_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/1347" - ] - } + } + ] + } + ], + "type": [ + "null", + "object" + ] + }, + "rules": { + "type": "array", + "items": { + "title": "Repository Rule", + "type": "object", + "description": "A repository rule.", + "oneOf": [ + { + "title": "creation", + "description": "Only allow users with bypass permission to create matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "creation" + ] + } + } + }, + { + "title": "update", + "description": "Only allow users with bypass permission to update matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "update" + ] }, - "required": [ - "issue_body_url" - ] - }, - { - "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", - "type": "object", - "properties": { - "issue_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue comment where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - ] - } + "parameters": { + "type": "object", + "properties": { + "update_allows_fetch_and_merge": { + "type": "boolean", + "description": "Branch can pull changes from its upstream repository" + } + }, + "required": [ + "update_allows_fetch_and_merge" + ] + } + } + }, + { + "title": "deletion", + "description": "Only allow users with bypass permissions to delete matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "deletion" + ] + } + } + }, + { + "title": "required_linear_history", + "description": "Prevent merge commits from being pushed to matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_linear_history" + ] + } + } + }, + { + "title": "merge_queue", + "description": "Merges must be performed via a merge queue.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "merge_queue" + ] }, - "required": [ - "issue_comment_url" - ] - }, - { - "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", - "type": "object", - "properties": { - "discussion_title_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "examples": [ - "https://github.com/community/community/discussions/39082" - ] - } + "parameters": { + "type": "object", + "properties": { + "check_response_timeout_minutes": { + "type": "integer", + "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", + "minimum": 1, + "maximum": 360 + }, + "grouping_strategy": { + "type": "string", + "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", + "enum": [ + "ALLGREEN", + "HEADGREEN" + ] + }, + "max_entries_to_build": { + "type": "integer", + "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", + "minimum": 0, + "maximum": 100 + }, + "max_entries_to_merge": { + "type": "integer", + "description": "The maximum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "merge_method": { + "type": "string", + "description": "Method to use when merging changes from queued pull requests.", + "enum": [ + "MERGE", + "SQUASH", + "REBASE" + ] + }, + "min_entries_to_merge": { + "type": "integer", + "description": "The minimum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "min_entries_to_merge_wait_minutes": { + "type": "integer", + "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", + "minimum": 0, + "maximum": 360 + } + }, + "required": [ + "check_response_timeout_minutes", + "grouping_strategy", + "max_entries_to_build", + "max_entries_to_merge", + "merge_method", + "min_entries_to_merge", + "min_entries_to_merge_wait_minutes" + ] + } + } + }, + { + "title": "required_deployments", + "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_deployments" + ] }, - "required": [ - "discussion_title_url" - ] - }, - { - "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", - "type": "object", - "properties": { - "discussion_body_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "examples": [ - "https://github.com/community/community/discussions/39082#discussion-4566270" - ] - } + "parameters": { + "type": "object", + "properties": { + "required_deployment_environments": { + "type": "array", + "description": "The environments that must be successfully deployed to before branches can be merged.", + "items": { + "type": "string" + } + } + }, + "required": [ + "required_deployment_environments" + ] + } + } + }, + { + "title": "required_signatures", + "description": "Commits pushed to matching refs must have verified signatures.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_signatures" + ] + } + } + }, + { + "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.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "pull_request" + ] }, - "required": [ - "discussion_body_url" - ] - }, - { - "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", - "type": "object", - "properties": { - "discussion_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the discussion comment where the secret was detected.", - "examples": [ - "https://github.com/community/community/discussions/39082#discussioncomment-4158232" - ] - } + "parameters": { + "type": "object", + "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", + "items": { + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "automatic_copilot_code_review_enabled": { + "type": "boolean", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean", + "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." + }, + "require_code_owner_review": { + "type": "boolean", + "description": "Require an approving review in pull requests that modify files that have a designated code owner." + }, + "require_last_push_approval": { + "type": "boolean", + "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." + }, + "required_approving_review_count": { + "type": "integer", + "description": "The number of approving reviews that are required before a pull request can be merged.", + "minimum": 0, + "maximum": 10 + }, + "required_review_thread_resolution": { + "type": "boolean", + "description": "All conversations on code must be resolved before a pull request can be merged." + } + }, + "required": [ + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "require_last_push_approval", + "required_approving_review_count", + "required_review_thread_resolution" + ] + } + } + }, + { + "title": "required_status_checks", + "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_status_checks" + ] }, - "required": [ - "discussion_comment_url" - ] - }, - { - "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.", - "type": "object", - "properties": { - "pull_request_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - ] - } + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "required_status_checks": { + "type": "array", + "description": "Status checks that are required.", + "items": { + "title": "StatusCheckConfiguration", + "description": "Required status check", + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "The status check context name that must be present on the commit." + }, + "integration_id": { + "type": "integer", + "description": "The optional integration ID that this status check must originate from." + } + }, + "required": [ + "context" + ] + } + }, + "strict_required_status_checks_policy": { + "type": "boolean", + "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." + } + }, + "required": [ + "required_status_checks", + "strict_required_status_checks_policy" + ] + } + } + }, + { + "title": "non_fast_forward", + "description": "Prevent users with push access from force pushing to refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "non_fast_forward" + ] + } + } + }, + { + "title": "commit_message_pattern", + "description": "Parameters to be used for the commit_message_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_message_pattern" + ] }, - "required": [ - "pull_request_title_url" - ] - }, - { - "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.", - "type": "object", - "properties": { - "pull_request_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - ] - } + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "commit_author_email_pattern", + "description": "Parameters to be used for the commit_author_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_author_email_pattern" + ] }, - "required": [ - "pull_request_body_url" - ] - }, - { - "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.", - "type": "object", - "properties": { - "pull_request_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request comment where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - ] - } + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "committer_email_pattern", + "description": "Parameters to be used for the committer_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "committer_email_pattern" + ] }, - "required": [ - "pull_request_comment_url" - ] - }, - { - "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.", - "type": "object", - "properties": { - "pull_request_review_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" - ] - } + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "branch_name_pattern", + "description": "Parameters to be used for the branch_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "branch_name_pattern" + ] }, - "required": [ - "pull_request_review_url" - ] - }, - { - "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.", - "type": "object", - "properties": { - "pull_request_review_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review comment where the secret was detected.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" - ] - } + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "tag_name_pattern", + "description": "Parameters to be used for the tag_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tag_name_pattern" + ] }, - "required": [ - "pull_request_review_comment_url" - ] + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } } - ] - } - ] - }, - "has_more_locations": { - "type": "boolean", - "description": "A boolean value representing whether or not the token in the alert was detected in more than one location." - } - } - } - }, - "examples": { - "default": { - "value": [ - { - "number": 2, - "created_at": "2020-11-06T18:48:51Z", - "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2", - "html_url": "https://github.com/owner/private-repo/security/secret-scanning/2", - "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations", - "state": "resolved", - "resolution": "false_positive", - "resolved_at": "2020-11-07T02:47:13Z", - "resolved_by": { - "login": "monalisa", - "id": 2, - "node_id": "MDQ6VXNlcjI=", - "avatar_url": "https://alambic.github.com/avatars/u/2?", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "site_admin": true - }, - "secret_type": "adafruit_io_key", - "secret_type_display_name": "Adafruit IO Key", - "secret": "aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX", - "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 + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } + }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + } + ] + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + } + }, + "examples": { + "default": { + "value": [ + { + "id": 21, + "name": "super cool ruleset", + "source_type": "Organization", + "source": "my-org", + "enforcement": "enabled", + "node_id": "RRS_lACkVXNlcgQB", + "_links": { + "self": { + "href": "https://api.github.com/orgs/my-org/rulesets/21" }, - "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" - }, - "push_protection_bypassed_by": { - "login": "monalisa", - "id": 2, - "node_id": "MDQ6VXNlcjI=", - "avatar_url": "https://alambic.github.com/avatars/u/2?", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "site_admin": true - }, - "push_protection_bypassed": true, - "push_protection_bypassed_at": "2020-11-06T21:48:51Z", - "push_protection_bypass_request_reviewer": { - "login": "octocat", - "id": 3, - "node_id": "MDQ6VXNlcjI=", - "avatar_url": "https://alambic.github.com/avatars/u/3?", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": true - }, - "push_protection_bypass_request_reviewer_comment": "Example response", - "push_protection_bypass_request_comment": "Example comment", - "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", - "resolution_comment": "Example comment", - "validity": "active", - "publicly_leaked": false, - "multi_repo": false, - "is_base64_encoded": false, - "first_location_detected": { - "path": "/example/secrets.txt", - "start_line": 1, - "end_line": 1, - "start_column": 1, - "end_column": 64, - "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", - "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", - "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", - "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + "html": { + "href": "https://github.com/organizations/my-org/settings/rules/21" + } }, - "has_more_locations": true + "created_at": "2023-07-15T08:43:03Z", + "updated_at": "2023-08-23T16:29:47Z" }, { - "number": 1, - "created_at": "2020-11-06T18:18:30Z", - "url": "https://api.github.com/repos/owner/repo/secret-scanning/alerts/1", - "html_url": "https://github.com/owner/repo/security/secret-scanning/1", - "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/1/locations", - "state": "open", - "resolution": null, - "resolved_at": null, - "resolved_by": null, - "secret_type": "mailchimp_api_key", - "secret_type_display_name": "Mailchimp API Key", - "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", - "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 + "id": 432, + "name": "Another ruleset", + "source_type": "Organization", + "source": "my-org", + "enforcement": "enabled", + "node_id": "RRS_lACkVXNlcgQQ", + "_links": { + "self": { + "href": "https://api.github.com/orgs/my-org/rulesets/432" }, - "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" - }, - "push_protection_bypassed_by": null, - "push_protection_bypassed": false, - "push_protection_bypassed_at": null, - "push_protection_bypass_request_reviewer": null, - "push_protection_bypass_request_reviewer_comment": null, - "push_protection_bypass_request_comment": null, - "push_protection_bypass_request_html_url": null, - "resolution_comment": null, - "validity": "unknown", - "publicly_leaked": false, - "multi_repo": false, - "is_base64_encoded": false, - "first_location_detected": { - "issue_title_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + "html": { + "href": "https://github.com/organizations/my-org/settings/rules/432" + } }, - "has_more_locations": false + "created_at": "2023-08-15T08:43:03Z", + "updated_at": "2023-09-23T16:29:47Z" } ] } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } } }, "404": { @@ -159579,47 +153179,50 @@ } } }, - "503": { - "description": "Service unavailable", + "500": { + "description": "Internal Error", "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" } } } } } } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "secret-scanning", - "subcategory": "secret-scanning" } - } - }, - "/orgs/{org}/security-advisories": { - "get": { - "summary": "List repository security advisories for an organization", - "description": "Lists repository security advisories 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 `repo` or `repository_advisories:write` scope to use this endpoint.", + }, + "post": { + "summary": "Create an organization repository ruleset", + "description": "Create a repository ruleset for an organization.", "tags": [ - "security-advisories" + "repos" ], - "operationId": "security-advisories/list-org-repository-advisories", + "operationId": "repos/create-org-ruleset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization" + "url": "https://docs.github.com/rest/orgs/rules#create-an-organization-repository-ruleset" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "rules" }, "parameters": [ { @@ -159630,2484 +153233,2448 @@ "schema": { "type": "string" } - }, - { - "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": "string", - "enum": [ - "created", - "updated", - "published" - ], - "default": "created" - } - }, - { - "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": "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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 - } - }, - { - "name": "state", - "description": "Filter by the state of the repository advisories. Only advisories of this state will be returned.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "triage", - "draft", - "published", - "closed" - ] - } } ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "description": "A repository security advisory.", + "requestBody": { + "description": "Request body", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the ruleset." + }, + "target": { + "type": "string", + "description": "The target of the ruleset", + "enum": [ + "branch", + "tag", + "push", + "repository" + ], + "default": "branch" + }, + "enforcement": { + "type": "string", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).", + "enum": [ + "disabled", + "active", + "evaluate" + ] + }, + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "title": "Repository Ruleset Bypass Actor", + "type": "object", + "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_type" + ], + "properties": { + "actor_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + }, + "actor_type": { + "type": "string", + "enum": [ + "Integration", + "OrganizationAdmin", + "RepositoryRole", + "Team", + "DeployKey" + ], + "description": "The type of actor that can bypass a ruleset." + }, + "bypass_mode": { + "type": "string", + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", + "enum": [ + "always", + "pull_request" + ], + "default": "always" + } + } + } + }, + "conditions": { + "title": "Organization ruleset conditions", "type": "object", - "properties": { - "ghsa_id": { - "type": "string", - "description": "The GitHub Security Advisory ID.", - "readOnly": true - }, - "cve_id": { - "type": [ - "string", - "null" - ], - "description": "The Common Vulnerabilities and Exposures (CVE) ID." - }, - "url": { - "type": "string", - "format": "uri", - "description": "The API URL for the advisory.", - "readOnly": true - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL for the advisory.", - "readOnly": true - }, - "summary": { - "type": "string", - "description": "A short summary of the advisory.", - "maxLength": 1024 - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "A detailed description of what the advisory entails.", - "maxLength": 65535 - }, - "severity": { - "type": [ - "string", - "null" - ], - "description": "The severity of the advisory.", - "enum": [ - "critical", - "high", - "medium", - "low", - null + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", + "oneOf": [ + { + "type": "object", + "title": "repository_name_and_ref_name", + "description": "Conditions to target repositories by name and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Repository ruleset conditions for repository names", + "type": "object", + "description": "Parameters for a repository name condition", + "properties": { + "repository_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + }, + "protected": { + "type": "boolean", + "description": "Whether renaming of target repositories is prevented." + } + } + } + }, + "required": [ + "repository_name" + ] + } ] }, - "author": { - "readOnly": true, - "description": "The author of the advisory.", + { + "type": "object", + "title": "repository_id_and_ref_name", + "description": "Conditions to target repositories by id and refs by name", "allOf": [ { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Repository ruleset conditions for ref names", "type": "object", + "description": "Parameters for a repository ruleset ref name condition", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Repository ruleset conditions for repository IDs", + "type": "object", + "description": "Parameters for a repository ID condition", + "properties": { + "repository_id": { + "type": "object", + "properties": { + "repository_ids": { + "type": "array", + "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "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" + "repository_id" ] } - ], - "type": [ - "null" ] }, - "publisher": { - "readOnly": true, - "description": "The publisher of the advisory.", + { + "type": "object", + "title": "repository_property_and_ref_name", + "description": "Conditions to target repositories by property and refs by name", "allOf": [ { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Repository ruleset conditions for ref names", "type": "object", + "description": "Parameters for a repository ruleset ref name condition", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Repository ruleset conditions for repository properties", + "type": "object", + "description": "Parameters for a repository property condition", + "properties": { + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + } + } } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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_property" ] } - ], - "type": [ - "null" ] - }, - "identifiers": { - "type": "array", - "items": { + } + ] + }, + "rules": { + "type": "array", + "description": "An array of rules within the ruleset.", + "items": { + "title": "Repository Rule", + "type": "object", + "description": "A repository rule.", + "oneOf": [ + { + "title": "creation", + "description": "Only allow users with bypass permission to create matching refs.", "type": "object", + "required": [ + "type" + ], "properties": { "type": { "type": "string", - "description": "The type of identifier.", "enum": [ - "CVE", - "GHSA" + "creation" ] - }, - "value": { + } + } + }, + { + "title": "update", + "description": "Only allow users with bypass permission to update matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "description": "The identifier value." + "enum": [ + "update" + ] + }, + "parameters": { + "type": "object", + "properties": { + "update_allows_fetch_and_merge": { + "type": "boolean", + "description": "Branch can pull changes from its upstream repository" + } + }, + "required": [ + "update_allows_fetch_and_merge" + ] } - }, + } + }, + { + "title": "deletion", + "description": "Only allow users with bypass permissions to delete matching refs.", + "type": "object", "required": [ - "type", - "value" - ] + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "deletion" + ] + } + } }, - "readOnly": true - }, - "state": { - "type": "string", - "description": "The state of the advisory.", - "enum": [ - "published", - "closed", - "withdrawn", - "draft", - "triage" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The date and time of when the advisory was created, in ISO 8601 format.", - "readOnly": true - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The date and time of when the advisory was last updated, in ISO 8601 format.", - "readOnly": true - }, - "published_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The date and time of when the advisory was published, in ISO 8601 format.", - "readOnly": true - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The date and time of when the advisory was closed, in ISO 8601 format.", - "readOnly": true - }, - "withdrawn_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.", - "readOnly": true - }, - "submission": { - "type": [ - "object", - "null" - ], - "readOnly": true, - "properties": { - "accepted": { - "type": "boolean", - "description": "Whether a private vulnerability report was accepted by the repository's administrators.", - "readOnly": true + { + "title": "required_linear_history", + "description": "Prevent merge commits from being pushed to matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_linear_history" + ] + } } }, - "required": [ - "accepted" - ] - }, - "vulnerabilities": { - "type": [ - "array", - "null" - ], - "items": { - "description": "A product affected by the vulnerability detailed in a repository security advisory.", + { + "title": "required_deployments", + "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", "type": "object", + "required": [ + "type" + ], "properties": { - "package": { - "description": "The name of the package affected by the vulnerability.", - "type": [ - "object", - "null" - ], + "type": { + "type": "string", + "enum": [ + "required_deployments" + ] + }, + "parameters": { + "type": "object", "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "enum": [ - "rubygems", - "npm", - "pip", - "maven", - "nuget", - "composer", - "go", - "rust", - "erlang", - "actions", - "pub", - "other", - "swift" - ] - }, - "name": { - "type": [ - "string", - "null" - ], - "description": "The unique package name within its ecosystem." + "required_deployment_environments": { + "type": "array", + "description": "The environments that must be successfully deployed to before branches can be merged.", + "items": { + "type": "string" + } } }, "required": [ - "ecosystem", - "name" + "required_deployment_environments" ] - }, - "vulnerable_version_range": { - "type": [ - "string", - "null" - ], - "description": "The range of the package versions affected by the vulnerability." - }, - "patched_versions": { - "type": [ - "string", - "null" - ], - "description": "The package version(s) that resolve the vulnerability." - }, - "vulnerable_functions": { - "type": [ - "array", - "null" - ], - "description": "The functions in the package that are affected.", - "items": { - "type": "string" - } } - }, + } + }, + { + "title": "required_signatures", + "description": "Commits pushed to matching refs must have verified signatures.", + "type": "object", "required": [ - "package", - "vulnerable_version_range", - "patched_versions", - "vulnerable_functions" + "type" ], - "additionalProperties": false - } - }, - "cvss": { - "type": [ - "object", - "null" - ], - "properties": { - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The CVSS vector." - }, - "score": { - "type": [ - "number", - "null" - ], - "description": "The CVSS score.", - "minimum": 0, - "maximum": 10, - "readOnly": true + "properties": { + "type": { + "type": "string", + "enum": [ + "required_signatures" + ] + } } }, - "required": [ - "vector_string", - "score" - ] - }, - "cvss_severities": { - "type": [ - "object", - "null" - ], - "properties": { - "cvss_v3": { - "type": [ - "object", - "null" - ], - "properties": { - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The CVSS 3 vector string." - }, - "score": { - "type": [ - "number", - "null" - ], - "description": "The CVSS 3 score.", - "minimum": 0, - "maximum": 10, - "readOnly": true - } + { + "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.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "pull_request" + ] }, - "required": [ - "vector_string", - "score" - ] - }, - "cvss_v4": { - "type": [ - "object", - "null" - ], - "properties": { - "vector_string": { - "type": [ - "string", - "null" - ], - "description": "The CVSS 4 vector string." + "parameters": { + "type": "object", + "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", + "items": { + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "automatic_copilot_code_review_enabled": { + "type": "boolean", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean", + "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." + }, + "require_code_owner_review": { + "type": "boolean", + "description": "Require an approving review in pull requests that modify files that have a designated code owner." + }, + "require_last_push_approval": { + "type": "boolean", + "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." + }, + "required_approving_review_count": { + "type": "integer", + "description": "The number of approving reviews that are required before a pull request can be merged.", + "minimum": 0, + "maximum": 10 + }, + "required_review_thread_resolution": { + "type": "boolean", + "description": "All conversations on code must be resolved before a pull request can be merged." + } }, - "score": { - "type": [ - "number", - "null" - ], - "description": "The CVSS 4 score.", - "minimum": 0, - "maximum": 10, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] + "required": [ + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "require_last_push_approval", + "required_approving_review_count", + "required_review_thread_resolution" + ] + } } - } - }, - "cwes": { - "type": [ - "array", - "null" - ], - "items": { + }, + { + "title": "required_status_checks", + "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", "type": "object", + "required": [ + "type" + ], "properties": { - "cwe_id": { + "type": { "type": "string", - "description": "The Common Weakness Enumeration (CWE) identifier." + "enum": [ + "required_status_checks" + ] }, - "name": { - "type": "string", - "description": "The name of the CWE.", - "readOnly": true + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "required_status_checks": { + "type": "array", + "description": "Status checks that are required.", + "items": { + "title": "StatusCheckConfiguration", + "description": "Required status check", + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "The status check context name that must be present on the commit." + }, + "integration_id": { + "type": "integer", + "description": "The optional integration ID that this status check must originate from." + } + }, + "required": [ + "context" + ] + } + }, + "strict_required_status_checks_policy": { + "type": "boolean", + "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." + } + }, + "required": [ + "required_status_checks", + "strict_required_status_checks_policy" + ] } - }, - "required": [ - "cwe_id", - "name" - ] + } }, - "readOnly": true - }, - "cwe_ids": { - "type": [ - "array", - "null" - ], - "description": "A list of only the CWE IDs.", - "items": { - "type": "string" - } - }, - "credits": { - "type": [ - "array", - "null" - ], - "items": { + { + "title": "non_fast_forward", + "description": "Prevent users with push access from force pushing to refs.", "type": "object", + "required": [ + "type" + ], "properties": { - "login": { - "type": "string", - "description": "The username of the user credited." - }, "type": { "type": "string", - "description": "The type of credit the user is receiving.", "enum": [ - "analyst", - "finder", - "reporter", - "coordinator", - "remediation_developer", - "remediation_reviewer", - "remediation_verifier", - "tool", - "sponsor", - "other" + "non_fast_forward" ] } } - } - }, - "credits_detailed": { - "type": [ - "array", - "null" - ], - "items": { - "description": "A credit given to a user for a repository security advisory.", + }, + { + "title": "commit_message_pattern", + "description": "Parameters to be used for the commit_message_pattern rule", "type": "object", + "required": [ + "type" + ], "properties": { - "user": { - "title": "Simple User", - "description": "A GitHub user.", + "type": { + "type": "string", + "enum": [ + "commit_message_pattern" + ] + }, + "parameters": { "type": "object", "properties": { "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] + "description": "How this rule will appear to users." }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." }, - "avatar_url": { + "operator": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" ] }, - "url": { + "pattern": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "commit_author_email_pattern", + "description": "Parameters to be used for the commit_author_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_author_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] + "description": "How this rule will appear to users." }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." }, - "following_url": { + "operator": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" ] }, - "gists_url": { + "pattern": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "committer_email_pattern", + "description": "Parameters to be used for the committer_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "committer_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] + "description": "How this rule will appear to users." }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." }, - "organizations_url": { + "operator": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" ] }, - "repos_url": { + "pattern": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "branch_name_pattern", + "description": "Parameters to be used for the branch_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "branch_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "description": "How this rule will appear to users." }, - "received_events_url": { + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" ] }, - "type": { + "pattern": { "type": "string", - "examples": [ - "User" - ] + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "tag_name_pattern", + "description": "Parameters to be used for the tag_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tag_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." }, - "site_admin": { - "type": "boolean" + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." }, - "starred_at": { + "operator": { "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" ] }, - "user_view_type": { + "pattern": { "type": "string", - "examples": [ - "public" - ] + "description": "The pattern to match with." } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "operator", + "pattern" ] - }, + } + } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { "type": { "type": "string", - "description": "The type of credit the user is receiving.", "enum": [ - "analyst", - "finder", - "reporter", - "coordinator", - "remediation_developer", - "remediation_reviewer", - "remediation_verifier", - "tool", - "sponsor", - "other" + "file_path_restriction" ] }, - "state": { - "type": "string", - "description": "The state of the user's acceptance of the credit.", - "enum": [ - "accepted", - "declined", - "pending" + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" ] } - }, - "required": [ - "user", - "type", - "state" - ], - "additionalProperties": false + } }, - "readOnly": true - }, - "collaborating_users": { - "type": [ - "array", - "null" - ], - "description": "A list of users that collaborate on the advisory.", - "items": { - "title": "Simple User", - "description": "A GitHub user.", + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", "type": "object", + "required": [ + "type" + ], "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { + "type": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "enum": [ + "max_file_path_length" ] }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" ] - }, - "starred_url": { + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "enum": [ + "file_extension_restriction" ] }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" ] - }, - "organizations_url": { + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" + "enum": [ + "max_file_size" ] }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" ] - }, - "events_url": { + } + } + }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "enum": [ + "workflows" ] }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" ] - }, + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { "type": { "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" + "enum": [ + "code_scanning" ] }, - "user_view_type": { - "type": "string", - "examples": [ - "public" + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" ] } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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": [ + "name", + "enforcement" + ] + }, + "examples": { + "default": { + "value": { + "name": "super cool ruleset", + "target": "branch", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] }, - "collaborating_teams": { - "type": [ - "array", - "null" + "repository_name": { + "include": [ + "important_repository", + "another_important_repository" ], - "description": "A list of teams that collaborate on the advisory.", - "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", + "exclude": [ + "unimportant_repository" + ], + "protected": true + } + }, + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" + } + } + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Repository ruleset", + "type": "object", + "description": "A set of rules to apply when specified conditions are met.", + "required": [ + "id", + "name", + "source", + "enforcement" + ], + "properties": { + "id": { + "type": "integer", + "description": "The ID of the ruleset" + }, + "name": { + "type": "string", + "description": "The name of the ruleset" + }, + "target": { + "type": "string", + "description": "The target of the ruleset", + "enum": [ + "branch", + "tag", + "push", + "repository" + ] + }, + "source_type": { + "type": "string", + "description": "The type of the source of the ruleset", + "enum": [ + "Repository", + "Organization", + "Enterprise" + ] + }, + "source": { + "type": "string", + "description": "The name of the source" + }, + "enforcement": { + "type": "string", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).", + "enum": [ + "disabled", + "active", + "evaluate" + ] + }, + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "title": "Repository Ruleset Bypass Actor", + "type": "object", + "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_type" + ], + "properties": { + "actor_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + }, + "actor_type": { + "type": "string", + "enum": [ + "Integration", + "OrganizationAdmin", + "RepositoryRole", + "Team", + "DeployKey" + ], + "description": "The type of actor that can bypass a ruleset." + }, + "bypass_mode": { + "type": "string", + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", + "enum": [ + "always", + "pull_request" + ], + "default": "always" + } + } + } + }, + "current_user_can_bypass": { + "type": "string", + "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", + "enum": [ + "always", + "pull_requests_only", + "never" + ] + }, + "node_id": { + "type": "string" + }, + "_links": { + "type": "object", + "properties": { + "self": { "type": "object", "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { + "href": { + "type": "string", + "description": "The URL of the ruleset" + } + } + }, + "html": { + "type": [ + "object", + "null" + ], + "properties": { + "href": { + "type": "string", + "description": "The html URL of the ruleset" + } + } + } + } + }, + "conditions": { + "anyOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { "type": "object", "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } }, - "maintain": { - "type": "boolean" + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Organization ruleset conditions", + "type": "object", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", + "oneOf": [ + { + "type": "object", + "title": "repository_name_and_ref_name", + "description": "Conditions to target repositories by name and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } }, - "admin": { - "type": "boolean" + { + "title": "Repository ruleset conditions for repository names", + "type": "object", + "description": "Parameters for a repository name condition", + "properties": { + "repository_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + }, + "protected": { + "type": "boolean", + "description": "Whether renaming of target repositories is prevented." + } + } + } + }, + "required": [ + "repository_name" + ] } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" ] }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" + { + "type": "object", + "title": "repository_id_and_ref_name", + "description": "Conditions to target repositories by id and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Repository ruleset conditions for repository IDs", + "type": "object", + "description": "Parameters for a repository ID condition", + "properties": { + "repository_id": { + "type": "object", + "properties": { + "repository_ids": { + "type": "array", + "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" + } + } + } + } + }, + "required": [ + "repository_id" + ] + } ] }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ + { + "type": "object", + "title": "repository_property_and_ref_name", + "description": "Conditions to target repositories by property and refs by name", + "allOf": [ { - "type": "null" + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } }, { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", + "title": "Repository ruleset conditions for repository properties", "type": "object", + "description": "Parameters for a repository property condition", "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + } + } } }, "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" + "repository_property" ] } ] } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" ] } - }, - "private_fork": { - "readOnly": true, - "description": "A temporary private fork of the advisory's repository for collaborating on a fix.", - "allOf": [ + ], + "type": [ + "null", + "object" + ] + }, + "rules": { + "type": "array", + "items": { + "title": "Repository Rule", + "type": "object", + "description": "A repository rule.", + "oneOf": [ { - "title": "Simple Repository", - "description": "A GitHub repository.", + "title": "creation", + "description": "Only allow users with bypass permission to create matching refs.", "type": "object", + "required": [ + "type" + ], "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "A unique identifier of the repository.", - "examples": [ - 1296269 + "type": { + "type": "string", + "enum": [ + "creation" ] - }, - "node_id": { + } + } + }, + { + "title": "update", + "description": "Only allow users with bypass permission to update matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "description": "The GraphQL identifier of the repository.", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "enum": [ + "update" ] }, - "name": { + "parameters": { + "type": "object", + "properties": { + "update_allows_fetch_and_merge": { + "type": "boolean", + "description": "Branch can pull changes from its upstream repository" + } + }, + "required": [ + "update_allows_fetch_and_merge" + ] + } + } + }, + { + "title": "deletion", + "description": "Only allow users with bypass permissions to delete matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "description": "The name of the repository.", - "examples": [ - "Hello-World" + "enum": [ + "deletion" ] - }, - "full_name": { + } + } + }, + { + "title": "required_linear_history", + "description": "Prevent merge commits from being pushed to matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "description": "The full, globally unique, name of the repository.", - "examples": [ - "octocat/Hello-World" + "enum": [ + "required_linear_history" + ] + } + } + }, + { + "title": "merge_queue", + "description": "Merges must be performed via a merge queue.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "merge_queue" ] }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", + "parameters": { "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] + "check_response_timeout_minutes": { + "type": "integer", + "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", + "minimum": 1, + "maximum": 360 }, - "login": { + "grouping_strategy": { "type": "string", - "examples": [ - "octocat" + "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", + "enum": [ + "ALLGREEN", + "HEADGREEN" ] }, - "id": { + "max_entries_to_build": { "type": "integer", - "format": "int64", - "examples": [ - 1 - ] + "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", + "minimum": 0, + "maximum": 100 }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "max_entries_to_merge": { + "type": "integer", + "description": "The maximum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 }, - "avatar_url": { + "merge_method": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "description": "Method to use when merging changes from queued pull requests.", + "enum": [ + "MERGE", + "SQUASH", + "REBASE" ] }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] + "min_entries_to_merge": { + "type": "integer", + "description": "The minimum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] + "min_entries_to_merge_wait_minutes": { + "type": "integer", + "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", + "minimum": 0, + "maximum": 360 + } + }, + "required": [ + "check_response_timeout_minutes", + "grouping_strategy", + "max_entries_to_build", + "max_entries_to_merge", + "merge_method", + "min_entries_to_merge", + "min_entries_to_merge_wait_minutes" + ] + } + } + }, + { + "title": "required_deployments", + "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_deployments" + ] + }, + "parameters": { + "type": "object", + "properties": { + "required_deployment_environments": { + "type": "array", + "description": "The environments that must be successfully deployed to before branches can be merged.", + "items": { + "type": "string" + } + } + }, + "required": [ + "required_deployment_environments" + ] + } + } + }, + { + "title": "required_signatures", + "description": "Commits pushed to matching refs must have verified signatures.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_signatures" + ] + } + } + }, + { + "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.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "pull_request" + ] + }, + "parameters": { + "type": "object", + "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", + "items": { + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] + "automatic_copilot_code_review_enabled": { + "type": "boolean", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] + "dismiss_stale_reviews_on_push": { + "type": "boolean", + "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] + "require_code_owner_review": { + "type": "boolean", + "description": "Require an approving review in pull requests that modify files that have a designated code owner." }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] + "require_last_push_approval": { + "type": "boolean", + "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] + "required_approving_review_count": { + "type": "integer", + "description": "The number of approving reviews that are required before a pull request can be merged.", + "minimum": 0, + "maximum": 10 }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "required_review_thread_resolution": { + "type": "boolean", + "description": "All conversations on code must be resolved before a pull request can be merged." + } + }, + "required": [ + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "require_last_push_approval", + "required_approving_review_count", + "required_review_thread_resolution" + ] + } + } + }, + { + "title": "required_status_checks", + "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_status_checks" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] + "required_status_checks": { + "type": "array", + "description": "Status checks that are required.", + "items": { + "title": "StatusCheckConfiguration", + "description": "Required status check", + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "The status check context name that must be present on the commit." + }, + "integration_id": { + "type": "integer", + "description": "The optional integration ID that this status check must originate from." + } + }, + "required": [ + "context" + ] + } }, - "repos_url": { + "strict_required_status_checks_policy": { + "type": "boolean", + "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." + } + }, + "required": [ + "required_status_checks", + "strict_required_status_checks_policy" + ] + } + } + }, + { + "title": "non_fast_forward", + "description": "Prevent users with push access from force pushing to refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "non_fast_forward" + ] + } + } + }, + { + "title": "commit_message_pattern", + "description": "Parameters to be used for the commit_message_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_message_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] + "description": "How this rule will appear to users." }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." }, - "received_events_url": { + "operator": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" ] }, - "type": { + "pattern": { "type": "string", - "examples": [ - "User" - ] + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "commit_author_email_pattern", + "description": "Parameters to be used for the commit_author_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_author_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." }, - "site_admin": { - "type": "boolean" + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." }, - "starred_at": { + "operator": { "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" ] }, - "user_view_type": { + "pattern": { "type": "string", - "examples": [ - "public" - ] + "description": "The pattern to match with." } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "operator", + "pattern" ] - }, - "private": { - "type": "boolean", - "description": "Whether the repository is private." - }, - "html_url": { + } + } + }, + { + "title": "committer_email_pattern", + "description": "Parameters to be used for the committer_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "format": "uri", - "description": "The URL to view the repository on GitHub.com.", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The repository description.", - "examples": [ - "This your first repo!" + "enum": [ + "committer_email_pattern" ] }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL to get more information about the repository from the GitHub API.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" ] - }, - "archive_url": { + } + } + }, + { + "title": "branch_name_pattern", + "description": "Parameters to be used for the branch_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "description": "A template for the API URL to download the repository as an archive.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + "enum": [ + "branch_name_pattern" ] }, - "assignees_url": { - "type": "string", - "description": "A template for the API URL to list the available assignees for issues in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" ] - }, - "blobs_url": { + } + } + }, + { + "title": "tag_name_pattern", + "description": "Parameters to be used for the tag_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + "enum": [ + "tag_name_pattern" ] }, - "branches_url": { - "type": "string", - "description": "A template for the API URL to get information about branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" ] - }, - "collaborators_url": { + } + } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "description": "A template for the API URL to get information about collaborators of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + "enum": [ + "file_path_restriction" ] }, - "comments_url": { - "type": "string", - "description": "A template for the API URL to get information about comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/comments{/number}" + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" ] - }, - "commits_url": { + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "description": "A template for the API URL to get information about commits on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "enum": [ + "max_file_path_length" ] }, - "compare_url": { - "type": "string", - "description": "A template for the API URL to compare two commits or refs.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" ] - }, - "contents_url": { + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "description": "A template for the API URL to get the contents of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "enum": [ + "file_extension_restriction" ] }, - "contributors_url": { - "type": "string", - "format": "uri", - "description": "A template for the API URL to list the contributors to the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contributors" + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" ] - }, - "deployments_url": { + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "format": "uri", - "description": "The API URL to list the deployments of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/deployments" + "enum": [ + "max_file_size" ] }, - "downloads_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the downloads on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/downloads" + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" ] - }, - "events_url": { + } + } + }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "format": "uri", - "description": "The API URL to list the events of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/events" + "enum": [ + "workflows" ] }, - "forks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the forks of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "description": "A template for the API URL to get information about Git commits of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "description": "A template for the API URL to get information about Git refs of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "description": "A template for the API URL to get information about Git tags of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "issue_comment_url": { - "type": "string", - "description": "A template for the API URL to get information about issue comments on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "description": "A template for the API URL to get information about issue events on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "description": "A template for the API URL to get information about issues on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "description": "A template for the API URL to get information about deploy keys on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "description": "A template for the API URL to get information about labels of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about the languages of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "description": "The API URL to merge branches in the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "description": "A template for the API URL to get information about milestones of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "description": "A template for the API URL to get information about notifications on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "description": "A template for the API URL to get information about pull requests on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "description": "A template for the API URL to get information about releases on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the stargazers on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "description": "A template for the API URL to get information about statuses of a commit.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the subscribers on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "description": "The API URL to subscribe to notifications for this repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get information about tags on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the teams on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/teams" + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" ] - }, - "trees_url": { + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + "enum": [ + "code_scanning" ] }, - "hooks_url": { - "type": "string", - "format": "uri", - "description": "The API URL to list the hooks on the repository.", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks" + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" ] } - }, - "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" - ] + } } - ], - "type": [ - "null" ] } }, - "required": [ - "ghsa_id", - "cve_id", - "url", - "html_url", - "summary", - "description", - "severity", - "author", - "publisher", - "identifiers", - "state", - "created_at", - "updated_at", - "published_at", - "closed_at", - "withdrawn_at", - "submission", - "vulnerabilities", - "cvss", - "cwes", - "cwe_ids", - "credits", - "credits_detailed", - "collaborating_users", - "collaborating_teams", - "private_fork" - ], - "additionalProperties": false + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } } }, "examples": { "default": { - "value": [ - { - "ghsa_id": "GHSA-abcd-1234-efgh", - "cve_id": "CVE-2050-00000", - "url": "https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh", - "html_url": "https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh", - "summary": "A short summary of the advisory.", - "description": "A detailed description of what the advisory entails.", - "severity": "critical", - "author": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "publisher": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "identifiers": [ - { - "type": "GHSA", - "value": "GHSA-abcd-1234-efgh" - }, - { - "type": "CVE", - "value": "CVE-2050-00000" - } - ], - "state": "published", - "created_at": "2020-01-01T00:00:00Z", - "updated_at": "2020-01-02T00:00:00Z", - "published_at": "2020-01-03T00:00:00Z", - "closed_at": null, - "withdrawn_at": null, - "submission": null, - "vulnerabilities": [ - { - "package": { - "ecosystem": "pip", - "name": "a-package" - }, - "vulnerable_version_range": ">= 1.0.0, < 1.0.1", - "patched_versions": "1.0.1", - "vulnerable_functions": [ - "function1" - ] - }, - { - "package": { - "ecosystem": "pip", - "name": "another-package" - }, - "vulnerable_version_range": ">= 1.0.0, < 1.0.2", - "patched_versions": "1.0.2", - "vulnerable_functions": [ - "function2" - ] - } - ], - "cvss": { - "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", - "score": 9.8 - }, - "cvss_severities": { - "cvss_v3": { - "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", - "score": 9.8 - }, - "cvss_v4": { - "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", - "score": 9.3 - } + "value": { + "id": 21, + "name": "super cool ruleset", + "target": "branch", + "source_type": "Organization", + "source": "my-org", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] }, - "cwes": [ - { - "cwe_id": "CWE-123", - "name": "A CWE" - } - ], - "cwe_ids": [ - "CWE-123" - ], - "credits": [ - { - "login": "octocat", - "type": "analyst" - } - ], - "credits_detailed": [ - { - "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 - }, - "type": "analyst", - "state": "accepted" - } - ], - "collaborating_users": [ - { - "login": "octokitten", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "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 - } - ], - "collaborating_teams": [ - { - "name": "Justice League", - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "permission": "admin", - "parent": null - } - ], - "private_fork": null + "repository_name": { + "include": [ + "important_repository", + "another_important_repository" + ], + "exclude": [ + "unimportant_repository" + ], + "protected": true + } }, - { - "ghsa_id": "GHSA-1234-5678-9012", - "cve_id": "CVE-2051-0000", - "url": "https://api.github.com/repos/repo/a-package/security-advisories/GHSA-1234-5678-9012", - "html_url": "https://github.com/repo/a-package/security/advisories/GHSA-1234-5678-9012", - "summary": "A short summary of the advisory.", - "description": "A detailed description of what the advisory entails.", - "severity": "low", - "author": { - "login": "monauser", - "id": 2, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/monauser", - "html_url": "https://github.com/monauser", - "followers_url": "https://api.github.com/users/monauser/followers", - "following_url": "https://api.github.com/users/monauser/following{/other_user}", - "gists_url": "https://api.github.com/users/monauser/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monauser/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monauser/subscriptions", - "organizations_url": "https://api.github.com/users/monauser/orgs", - "repos_url": "https://api.github.com/users/monauser/repos", - "events_url": "https://api.github.com/users/monauser/events{/privacy}", - "received_events_url": "https://api.github.com/users/monauser/received_events", - "type": "User", - "site_admin": false - }, - "publisher": { - "login": "monalisa", - "id": 3, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "site_admin": false - }, - "identifiers": [ - { - "type": "GHSA", - "value": "GHSA-1234-5678-9012" - }, - { - "type": "CVE", - "value": "CVE-2051-00000" - } - ], - "state": "published", - "created_at": "2020-01-03T00:00:00Z", - "updated_at": "2020-01-04T00:00:00Z", - "published_at": "2020-01-04T00:00:00Z", - "closed_at": null, - "withdrawn_at": null, - "submission": { - "accepted": true - }, - "vulnerabilities": [ - { - "package": { - "ecosystem": "pip", - "name": "a-package" - }, - "vulnerable_version_range": ">= 1.0.0, < 1.0.1", - "patched_versions": "1.0.1", - "vulnerable_functions": [ - "function1" - ] - }, - { - "package": { - "ecosystem": "pip", - "name": "another-package" - }, - "vulnerable_version_range": ">= 1.0.0, < 1.0.2", - "patched_versions": "1.0.2", - "vulnerable_functions": [ - "function2" - ] - } - ], - "cvss": { - "vector_string": "AV:P/AC:H/PR:H/UI:R/S:U/C:N/I:L/A:N", - "score": 1.6 - }, - "cvss_severities": { - "cvss_v3": { - "vector_string": "CVSS:3.1/AV:P/AC:H/PR:H/UI:R/S:U/C:N/I:L/A:N", - "score": 1.6 - }, - "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": 7.1 + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" } + } + ], + "node_id": "RRS_lACkVXNlcgQB", + "_links": { + "self": { + "href": "https://api.github.com/orgs/my-org/rulesets/21" }, - "cwes": [ - { - "cwe_id": "CWE-456", - "name": "A CWE 2.0" - } - ], - "cwe_ids": [ - "CWE-456" - ], - "credits": [ - { - "login": "monauser", - "type": "reporter" - } - ], - "credits_detailed": [ - { - "user": { - "login": "monauser", - "id": 2, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/monauser", - "html_url": "https://github.com/monauser", - "followers_url": "https://api.github.com/users/monauser/followers", - "following_url": "https://api.github.com/users/monauser/following{/other_user}", - "gists_url": "https://api.github.com/users/monauser/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monauser/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monauser/subscriptions", - "organizations_url": "https://api.github.com/users/monauser/orgs", - "repos_url": "https://api.github.com/users/monauser/repos", - "events_url": "https://api.github.com/users/monauser/events{/privacy}", - "received_events_url": "https://api.github.com/users/monauser/received_events", - "type": "User", - "site_admin": false - }, - "type": "reporter", - "state": "accepted" - } - ], - "collaborating_users": [ - { - "login": "octokitten", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "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 - } - ], - "collaborating_teams": [ - { - "name": "Justice League", - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "permission": "admin", - "parent": null - } - ], - "private_fork": { - "id": 217723378, - "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=", - "name": "octo-repo-ghsa-1234-5678-9012", - "full_name": "octo-org/octo-repo-ghsa-1234-5678-9012", - "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-ghsa-1234-5678-9012", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012", - "archive_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/comments{/number}", - "commits_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/commits{/sha}", - "compare_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/contributors", - "deployments_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/deployments", - "downloads_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/downloads", - "events_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/events", - "forks_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/forks", - "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/tags{/sha}", - "hooks_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/hooks", - "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/issues{/number}", - "keys_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/labels{/name}", - "languages_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/languages", - "merges_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/merges", - "milestones_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/pulls{/number}", - "releases_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/releases{/id}", - "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/stargazers", - "statuses_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/subscribers", - "subscription_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/subscription", - "tags_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/tags", - "teams_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/teams", - "trees_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/trees{/sha}" + "html": { + "href": "https://github.com/organizations/my-org/settings/rules/21" } - } - ] + }, + "created_at": "2023-08-15T08:43:03Z", + "updated_at": "2023-09-23T16:29:47Z" + } } } } } }, - "400": { - "description": "Bad Request", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -162129,53 +155696,11 @@ } } } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": [ - "string", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } } } }, - "404": { - "description": "Resource not found", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -162200,26 +155725,20 @@ } } } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "security-advisories", - "subcategory": "repository-advisories" } } }, - "/orgs/{org}/security-managers": { + "/orgs/{org}/rulesets/rule-suites": { "get": { - "summary": "List security manager teams", - "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the \"[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)\" endpoints instead.", + "summary": "List organization rule suites", + "description": "Lists suites of rule evaluations at the organization level.\nFor more information, see \"[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets).\"", "tags": [ - "orgs" + "repos" ], - "operationId": "orgs/list-security-manager-teams", + "operationId": "repos/get-org-rule-suites", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/security-managers#list-security-manager-teams" + "url": "https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites" }, "parameters": [ { @@ -162230,6 +155749,80 @@ "schema": { "type": "string" } + }, + { + "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 to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned.", + "in": "query", + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + { + "name": "repository_name", + "description": "The name of the repository to filter on.", + "in": "query", + "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": "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" + } + }, + { + "name": "rule_suite_result", + "description": "The rule suite results to filter on. When specified, only suites with this result will be returned.", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "pass", + "fail", + "bypass", + "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", + "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": { @@ -162238,521 +155831,152 @@ "content": { "application/json": { "schema": { + "title": "Rule Suites", + "description": "Response", "type": "array", "items": { - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] + "description": "The unique identifier of the rule insight." }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] + "actor_id": { + "type": "integer", + "description": "The number that identifies the user." }, - "members_url": { + "actor_name": { "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] + "description": "The handle for the GitHub user account." }, - "name": { - "description": "Name of the team", + "before_sha": { "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] + "description": "The first commit sha before the push evaluation." }, - "permission": { - "description": "Permission that the team will have for its repositories", + "after_sha": { "type": "string", - "examples": [ - "admin" - ] + "description": "The last commit sha in the push evaluation." }, - "privacy": { - "description": "The level of privacy this team should have", + "ref": { "type": "string", - "examples": [ - "closed" - ] + "description": "The ref name that the evaluation ran on." }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] + "repository_id": { + "type": "integer", + "description": "The ID of the repository associated with the rule evaluation." }, - "html_url": { + "repository_name": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] + "description": "The name of the repository without the `.git` extension." }, - "repositories_url": { + "pushed_at": { "type": "string", - "format": "uri", + "format": "date-time", "examples": [ - "https://api.github.com/organizations/1/team/1/repos" + "2011-01-26T19:06:43Z" ] }, - "slug": { + "result": { "type": "string", - "examples": [ - "justice-league" - ] + "enum": [ + "pass", + "fail", + "bypass" + ], + "description": "The result of the rule evaluations for rules with the `active` enforcement status." }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "evaluation_result": { "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] + "enum": [ + "pass", + "fail", + "bypass" + ], + "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`." } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] + } } }, "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 + "id": 21, + "actor_id": 12, + "actor_name": "octocat", + "before_sha": "893f768e172fb1bc9c5d6f3dd48557e45f14e01d", + "after_sha": "dedd88641a362b6b4ea872da4847d6131a164d01", + "ref": "refs/heads/i-see-everything", + "repository_id": 404, + "repository_name": "octo-repo", + "pushed_at": "2023-07-06T08:43:03Z", + "result": "bypass" + }, + { + "id": 25, + "actor_id": 11, + "actor_name": "not-octocat", + "before_sha": "48994e4e01ccc943624c6231f172702b82b233cc", + "after_sha": "ecfd5a1025fa271a33ca5608d089476a2df3c9a1", + "ref": "refs/heads/i-am-everything", + "repository_id": 404, + "repository_name": "octo-repo", + "pushed_at": "2023-07-07T08:43:03Z", + "result": "pass", + "evaluation_result": "fail" } ] } } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [], - "category": "orgs", - "subcategory": "security-managers", - "deprecationDate": "2024-12-01", - "removalDate": "2026-01-01" - }, - "deprecated": true - } - }, - "/orgs/{org}/security-managers/teams/{team_slug}": { - "put": { - "summary": "Add a security manager team", - "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the \"[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)\" endpoints instead.", - "tags": [ - "orgs" - ], - "operationId": "orgs/add-security-manager-team", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/security-managers#add-a-security-manager-team" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [], - "category": "orgs", - "subcategory": "security-managers", - "deprecationDate": "2024-12-01", - "removalDate": "2026-01-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Remove a security manager team", - "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the \"[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)\" endpoints instead.", - "tags": [ - "orgs" - ], - "operationId": "orgs/remove-security-manager-team", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/security-managers#remove-a-security-manager-team" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [], - "category": "orgs", - "subcategory": "security-managers", - "deprecationDate": "2024-12-01", - "removalDate": "2026-01-01" - }, - "deprecated": true - } - }, - "/orgs/{org}/settings/billing/actions": { - "get": { - "summary": "Get GitHub Actions billing for an organization", - "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 returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint.", - "operationId": "billing/get-github-actions-billing-org", - "tags": [ - "billing" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/billing/billing#get-github-actions-billing-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": { - "total_minutes_used": { - "type": "integer", - "description": "The sum of the free and paid GitHub Actions minutes used." + "message": { + "type": "string" }, - "total_paid_minutes_used": { - "type": "integer", - "description": "The total paid GitHub Actions minutes used." + "documentation_url": { + "type": "string" }, - "included_minutes": { - "type": "integer", - "description": "The amount of free GitHub Actions minutes available." + "url": { + "type": "string" }, - "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 - } + "status": { + "type": "string" } } } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "billing", - "subcategory": "billing" - } - } - }, - "/orgs/{org}/settings/billing/packages": { - "get": { - "summary": "Get GitHub Packages billing for an organization", - "description": "Gets the free and paid storage used for GitHub Packages in gigabytes.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint.", - "operationId": "billing/get-github-packages-billing-org", - "tags": [ - "billing" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/billing/billing#get-github-packages-billing-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", + }, + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "total_gigabytes_bandwidth_used": { - "type": "integer", - "description": "Sum of the free and paid storage space (GB) for GitHuub Packages." - }, - "total_paid_gigabytes_bandwidth_used": { - "type": "integer", - "description": "Total paid storage space (GB) for GitHuub Packages." + "message": { + "type": "string" }, - "included_gigabytes_bandwidth": { - "type": "integer", - "description": "Free storage space (GB) for GitHub Packages." - } - }, - "required": [ - "total_gigabytes_bandwidth_used", - "total_paid_gigabytes_bandwidth_used", - "included_gigabytes_bandwidth" - ] - }, - "examples": { - "default": { - "value": { - "total_gigabytes_bandwidth_used": 50, - "total_paid_gigabytes_bandwidth_used": 40, - "included_gigabytes_bandwidth": 10 - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "billing", - "subcategory": "billing" - } - } - }, - "/orgs/{org}/settings/billing/shared-storage": { - "get": { - "summary": "Get shared storage billing for an organization", - "description": "Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint.", - "operationId": "billing/get-shared-storage-billing-org", - "tags": [ - "billing" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/billing/billing#get-shared-storage-billing-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": { - "days_left_in_billing_cycle": { - "type": "integer", - "description": "Numbers of days left in billing cycle." + "documentation_url": { + "type": "string" }, - "estimated_paid_storage_for_month": { - "type": "integer", - "description": "Estimated storage space (GB) used in billing cycle." + "url": { + "type": "string" }, - "estimated_storage_for_month": { - "type": "integer", - "description": "Estimated sum of free and paid storage space (GB) used in billing cycle." - } - }, - "required": [ - "days_left_in_billing_cycle", - "estimated_paid_storage_for_month", - "estimated_storage_for_month" - ] - }, - "examples": { - "default": { - "value": { - "days_left_in_billing_cycle": 20, - "estimated_paid_storage_for_month": 15, - "estimated_storage_for_month": 40 + "status": { + "type": "string" } } } @@ -162762,23 +155986,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "billing", - "subcategory": "billing" + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "rule-suites" } } }, - "/orgs/{org}/settings/network-configurations": { + "/orgs/{org}/rulesets/rule-suites/{rule_suite_id}": { "get": { - "summary": "List hosted compute network configurations for an organization", - "description": "Lists all hosted compute network configurations configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint.", + "summary": "Get an organization rule suite", + "description": "Gets information about a suite of rule evaluations from within an organization.\nFor more information, see \"[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets).\"", "tags": [ - "hosted-compute" + "repos" ], - "operationId": "hosted-compute/list-network-configurations-for-org", + "operationId": "repos/get-org-rule-suite", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/network-configurations#list-hosted-compute-network-configurations-for-an-organization" + "url": "https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite" }, "parameters": [ { @@ -162791,21 +156015,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", - "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": "rule_suite_id", + "description": "The unique identifier of the rule suite result.\nTo get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites)\nfor repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites)\nfor organizations.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" } } ], @@ -162815,72 +156030,135 @@ "content": { "application/json": { "schema": { + "title": "Rule Suite", + "description": "Response", "type": "object", - "required": [ - "total_count", - "network_configurations" - ], "properties": { - "total_count": { - "type": "integer" + "id": { + "type": "integer", + "description": "The unique identifier of the rule insight." }, - "network_configurations": { + "actor_id": { + "type": [ + "integer", + "null" + ], + "description": "The number that identifies the user." + }, + "actor_name": { + "type": [ + "string", + "null" + ], + "description": "The handle for the GitHub user account." + }, + "before_sha": { + "type": "string", + "description": "The first commit sha before the push evaluation." + }, + "after_sha": { + "type": "string", + "description": "The last commit sha in the push evaluation." + }, + "ref": { + "type": "string", + "description": "The ref name that the evaluation ran on." + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository associated with the rule evaluation." + }, + "repository_name": { + "type": "string", + "description": "The name of the repository without the `.git` extension." + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "result": { + "type": "string", + "enum": [ + "pass", + "fail", + "bypass" + ], + "description": "The result of the rule evaluations for rules with the `active` enforcement status." + }, + "evaluation_result": { + "type": [ + "string", + "null" + ], + "enum": [ + "pass", + "fail", + "bypass", + null + ], + "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. Null if no rules with `evaluate` enforcement status were run." + }, + "rule_evaluations": { "type": "array", + "description": "Details on the evaluated rules.", "items": { - "title": "Hosted compute network configuration", - "description": "A hosted compute network configuration.", "type": "object", "properties": { - "id": { - "description": "The unique identifier of the network configuration.", - "type": "string", - "examples": [ - "123ABC456DEF789" - ] + "rule_source": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of rule source." + }, + "id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the rule source." + }, + "name": { + "type": [ + "string", + "null" + ], + "description": "The name of the rule source." + } + } }, - "name": { - "description": "The name of the network configuration.", + "enforcement": { "type": "string", - "examples": [ - "my-network-configuration" - ] + "enum": [ + "active", + "evaluate", + "deleted ruleset" + ], + "description": "The enforcement level of this rule source." }, - "compute_service": { - "description": "The hosted compute service the network configuration supports.", + "result": { "type": "string", "enum": [ - "none", - "actions", - "codespaces" - ] + "pass", + "fail" + ], + "description": "The result of the evaluation of the individual rule." }, - "network_settings_ids": { - "description": "The unique identifier of each network settings in the configuration.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "123ABC456DEF789" - ] + "rule_type": { + "type": "string", + "description": "The type of rule." }, - "created_on": { - "description": "The time at which the network configuration was created, in ISO 8601 format.", + "details": { "type": [ "string", "null" ], - "format": "date-time", - "examples": [ - "2024-04-26T11:31:07Z" - ] + "description": "The detailed failure message for the rule. Null if the rule passed." } - }, - "required": [ - "id", - "name", - "created_on" - ] + } } } } @@ -162888,193 +156166,100 @@ "examples": { "default": { "value": { - "total_count": 2, - "network_configurations": [ + "id": 21, + "actor_id": 12, + "actor_name": "octocat", + "before_sha": "893f768e172fb1bc9c5d6f3dd48557e45f14e01d", + "after_sha": "dedd88641a362b6b4ea872da4847d6131a164d01", + "ref": "refs/heads/i-see-everything", + "repository_id": 404, + "repository_name": "octo-repo", + "pushed_at": "2023-07-06T08:43:03Z", + "result": "bypass", + "evaluation_result": "fail", + "rule_evaluations": [ { - "id": "123456789ABCDEF", - "name": "My network configuration", - "compute_service": "actions", - "network_settings_ids": [ - "23456789ABDCEF1", - "3456789ABDCEF12" - ], - "created_on": "2022-10-09T23:39:01Z" + "rule_source": { + "type": "ruleset", + "id": 2, + "name": "Author email must be a GitHub email address" + }, + "enforcement": "active", + "result": "pass", + "rule_type": "commit_author_email_pattern" }, { - "id": "456789ABDCEF123", - "name": "My other configuration", - "compute_service": "none", - "network_settings_ids": [ - "56789ABDCEF1234", - "6789ABDCEF12345" - ], - "created_on": "2023-04-26T15:23:37Z" + "rule_source": { + "type": "protected_branch" + }, + "enforcement": "active", + "result": "fail", + "rule_type": "pull_request", + "details": "Changes must be made through a pull request." + }, + { + "rule_source": { + "type": "ruleset", + "id": 3, + "name": "Evaluate commit message pattern" + }, + "enforcement": "evaluate", + "result": "fail", + "rule_type": "commit_message_pattern" } ] } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "network-configurations" - } - }, - "post": { - "summary": "Create a hosted compute network configuration for an organization", - "description": "Creates a hosted compute network configuration for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint.", - "tags": [ - "hosted-compute" - ], - "operationId": "hosted-compute/create-network-configuration-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/network-configurations#create-a-hosted-compute-network-configuration-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 network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.", - "type": "string" - }, - "compute_service": { - "description": "The hosted compute service to use for the network configuration.", - "type": "string", - "enum": [ - "none", - "actions" - ] - }, - "network_settings_ids": { - "type": "array", - "minItems": 1, - "maxItems": 1, - "description": "The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified.", - "items": { + }, + "404": { + "description": "Resource not found", + "content": { + "application/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": [ - "name", - "network_settings_ids" - ] - }, - "examples": { - "default": { - "value": { - "name": "my-network-configuration", - "network_settings_ids": [ - "23456789ABDCEF1" - ], - "compute_service": "actions" - } } } } - } - }, - "responses": { - "201": { - "description": "Response", + }, + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { - "title": "Hosted compute network configuration", - "description": "A hosted compute network configuration.", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "id": { - "description": "The unique identifier of the network configuration.", - "type": "string", - "examples": [ - "123ABC456DEF789" - ] - }, - "name": { - "description": "The name of the network configuration.", - "type": "string", - "examples": [ - "my-network-configuration" - ] + "message": { + "type": "string" }, - "compute_service": { - "description": "The hosted compute service the network configuration supports.", - "type": "string", - "enum": [ - "none", - "actions", - "codespaces" - ] + "documentation_url": { + "type": "string" }, - "network_settings_ids": { - "description": "The unique identifier of each network settings in the configuration.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "123ABC456DEF789" - ] + "url": { + "type": "string" }, - "created_on": { - "description": "The time at which the network configuration was created, in ISO 8601 format.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2024-04-26T11:31:07Z" - ] - } - }, - "required": [ - "id", - "name", - "created_on" - ] - }, - "examples": { - "default": { - "value": { - "id": "123456789ABCDEF", - "name": "My network configuration", - "compute_service": "actions", - "network_settings_ids": [ - "23456789ABDCEF1", - "3456789ABDCEF12" - ], - "created_on": "2022-10-09T23:39:01Z" + "status": { + "type": "string" } } } @@ -163086,21 +156271,27 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", - "subcategory": "network-configurations" + "subcategory": "rule-suites" } } }, - "/orgs/{org}/settings/network-configurations/{network_configuration_id}": { + "/orgs/{org}/rulesets/{ruleset_id}": { "get": { - "summary": "Get a hosted compute network configuration for an organization", - "description": "Gets a hosted compute network configuration configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint.", + "summary": "Get an organization repository ruleset", + "description": "Get a repository ruleset for an organization.\n\n**Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user\nmaking the API request has write access to the ruleset.", "tags": [ - "hosted-compute" + "repos" ], - "operationId": "hosted-compute/get-network-configuration-for-org", + "operationId": "repos/get-org-ruleset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization" + "url": "https://docs.github.com/rest/orgs/rules#get-an-organization-repository-ruleset" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "rules" }, "parameters": [ { @@ -163113,12 +156304,12 @@ } }, { - "name": "network_configuration_id", - "description": "Unique identifier of the hosted compute network configuration.", + "name": "ruleset_id", + "description": "The ID of the ruleset.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], @@ -163128,969 +156319,1316 @@ "content": { "application/json": { "schema": { - "title": "Hosted compute network configuration", - "description": "A hosted compute network configuration.", + "title": "Repository ruleset", "type": "object", + "description": "A set of rules to apply when specified conditions are met.", + "required": [ + "id", + "name", + "source", + "enforcement" + ], "properties": { "id": { - "description": "The unique identifier of the network configuration.", + "type": "integer", + "description": "The ID of the ruleset" + }, + "name": { "type": "string", - "examples": [ - "123ABC456DEF789" + "description": "The name of the ruleset" + }, + "target": { + "type": "string", + "description": "The target of the ruleset", + "enum": [ + "branch", + "tag", + "push", + "repository" ] }, - "name": { - "description": "The name of the network configuration.", + "source_type": { "type": "string", - "examples": [ - "my-network-configuration" + "description": "The type of the source of the ruleset", + "enum": [ + "Repository", + "Organization", + "Enterprise" ] }, - "compute_service": { - "description": "The hosted compute service the network configuration supports.", + "source": { + "type": "string", + "description": "The name of the source" + }, + "enforcement": { "type": "string", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).", "enum": [ - "none", - "actions", - "codespaces" + "disabled", + "active", + "evaluate" ] }, - "network_settings_ids": { - "description": "The unique identifier of each network settings in the configuration.", + "bypass_actors": { "type": "array", + "description": "The actors that can bypass the rules in this ruleset", "items": { - "type": "string" - }, - "examples": [ - "123ABC456DEF789" - ] - }, - "created_on": { - "description": "The time at which the network configuration was created, in ISO 8601 format.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2024-04-26T11:31:07Z" - ] - } - }, - "required": [ - "id", - "name", - "created_on" - ] - }, - "examples": { - "default": { - "value": { - "id": "123456789ABCDEF", - "name": "My network configuration", - "compute_service": "actions", - "network_settings_ids": [ - "23456789ABDCEF1", - "3456789ABDCEF12" - ], - "created_on": "2022-10-09T23:39:01Z" - } - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "network-configurations" - } - }, - "patch": { - "summary": "Update a hosted compute network configuration for an organization", - "description": "Updates a hosted compute network configuration for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint.", - "tags": [ - "hosted-compute" - ], - "operationId": "hosted-compute/update-network-configuration-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/network-configurations#update-a-hosted-compute-network-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": "network_configuration_id", - "description": "Unique identifier of the hosted compute network configuration.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "description": "Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.", - "type": "string" - }, - "compute_service": { - "description": "The hosted compute service to use for the network configuration.", - "type": "string", - "enum": [ - "none", - "actions" - ] - }, - "network_settings_ids": { - "type": "array", - "minItems": 0, - "maxItems": 1, - "description": "The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified.", - "items": { - "type": "string" - } - } - } - }, - "examples": { - "default": { - "value": { - "name": "my-network-configuration", - "network_settings_ids": [ - "23456789ABDCEF1" - ], - "compute_service": "actions" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Hosted compute network configuration", - "description": "A hosted compute network configuration.", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the network configuration.", - "type": "string", - "examples": [ - "123ABC456DEF789" - ] - }, - "name": { - "description": "The name of the network configuration.", - "type": "string", - "examples": [ - "my-network-configuration" - ] + "title": "Repository Ruleset Bypass Actor", + "type": "object", + "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_type" + ], + "properties": { + "actor_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + }, + "actor_type": { + "type": "string", + "enum": [ + "Integration", + "OrganizationAdmin", + "RepositoryRole", + "Team", + "DeployKey" + ], + "description": "The type of actor that can bypass a ruleset." + }, + "bypass_mode": { + "type": "string", + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", + "enum": [ + "always", + "pull_request" + ], + "default": "always" + } + } + } }, - "compute_service": { - "description": "The hosted compute service the network configuration supports.", + "current_user_can_bypass": { "type": "string", + "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", "enum": [ - "none", - "actions", - "codespaces" - ] - }, - "network_settings_ids": { - "description": "The unique identifier of each network settings in the configuration.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "123ABC456DEF789" - ] - }, - "created_on": { - "description": "The time at which the network configuration was created, in ISO 8601 format.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2024-04-26T11:31:07Z" - ] - } - }, - "required": [ - "id", - "name", - "created_on" - ] - }, - "examples": { - "default": { - "value": { - "id": "123456789ABCDEF", - "name": "My network configuration", - "compute_service": "actions", - "network_settings_ids": [ - "23456789ABDCEF1", - "3456789ABDCEF12" - ], - "created_on": "2022-10-09T23:39:01Z" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "network-configurations" - } - }, - "delete": { - "summary": "Delete a hosted compute network configuration from an organization", - "description": "Deletes a hosted compute network configuration from an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint.", - "tags": [ - "hosted-compute" - ], - "operationId": "hosted-compute/delete-network-configuration-from-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "network_configuration_id", - "description": "Unique identifier of the hosted compute network configuration.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "network-configurations" - } - } - }, - "/orgs/{org}/settings/network-settings/{network_settings_id}": { - "get": { - "summary": "Get a hosted compute network settings resource for an organization", - "description": "Gets a hosted compute network settings resource configured for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint.", - "tags": [ - "hosted-compute" - ], - "operationId": "hosted-compute/get-network-settings-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "network_settings_id", - "description": "Unique identifier of the hosted compute network settings.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Hosted compute network settings resource", - "description": "A hosted compute network settings resource.", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier of the network settings resource.", - "type": "string", - "examples": [ - "220F78DACB92BBFBC5E6F22DE1CCF52309D" - ] - }, - "network_configuration_id": { - "description": "The identifier of the network configuration that is using this settings resource.", - "type": "string", - "examples": [ - "934E208B3EE0BD60CF5F752C426BFB53562" + "always", + "pull_requests_only", + "never" ] }, - "name": { - "description": "The name of the network settings resource.", - "type": "string", - "examples": [ - "my-network-settings" - ] + "node_id": { + "type": "string" }, - "subnet_id": { - "description": "The subnet this network settings resource is configured for.", - "type": "string", - "examples": [ - "/subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet" - ] + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "The URL of the ruleset" + } + } + }, + "html": { + "type": [ + "object", + "null" + ], + "properties": { + "href": { + "type": "string", + "description": "The html URL of the ruleset" + } + } + } + } }, - "region": { - "description": "The location of the subnet this network settings resource is configured for.", - "type": "string", - "examples": [ - "eastus" - ] - } - }, - "required": [ - "id", - "name", - "subnet_id", - "region" - ] - }, - "examples": { - "default": { - "value": { - "id": "220F78DACB92BBFBC5E6F22DE1CCF52309D", - "network_configuration_id": "934E208B3EE0BD60CF5F752C426BFB53562", - "name": "my_network_settings", - "subnet_id": "/subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet", - "region": "eastus" - } - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "network-configurations" - } - } - }, - "/orgs/{org}/team/{team_slug}/copilot/metrics": { - "get": { - "summary": "Get Copilot metrics for a team", - "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 team had **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 containing the team within GitHub settings.\nOnly organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team.\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-team", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "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", - "null" - ], - "description": "Usage metrics for Copilot editor code completions in the IDE.", - "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": { + "conditions": { + "anyOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { "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." + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } }, - "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." + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } } } } - }, - "editors": { - "type": "array", - "items": { + } + }, + { + "title": "Organization ruleset conditions", + "type": "object", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", + "oneOf": [ + { "type": "object", - "description": "Copilot code completion metrics for active editors.", - "additionalProperties": true, - "properties": { - "name": { - "type": "string", - "description": "Name of the given editor." + "title": "repository_name_and_ref_name", + "description": "Conditions to target repositories by name and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } }, - "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." + { + "title": "Repository ruleset conditions for repository names", + "type": "object", + "description": "Parameters for a repository name condition", + "properties": { + "repository_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + }, + "protected": { + "type": "boolean", + "description": "Whether renaming of target repositories is prevented." + } + } + } + }, + "required": [ + "repository_name" + ] + } + ] + }, + { + "type": "object", + "title": "repository_id_and_ref_name", + "description": "Conditions to target repositories by id and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } }, - "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", - "null" - ], - "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." + { + "title": "Repository ruleset conditions for repository IDs", + "type": "object", + "description": "Parameters for a repository ID condition", + "properties": { + "repository_id": { + "type": "object", + "properties": { + "repository_ids": { + "type": "array", + "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" + } + } + } + } + }, + "required": [ + "repository_id" + ] + } + ] + }, + { + "type": "object", + "title": "repository_property_and_ref_name", + "description": "Conditions to target repositories by property and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Repository ruleset conditions for repository properties", + "type": "object", + "description": "Parameters for a repository property condition", + "properties": { + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } }, - "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." + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } }, - "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": [ + "name", + "property_values" + ] } } } } - } + }, + "required": [ + "repository_property" + ] } - } + ] } - } + ] } - }, - "copilot_ide_chat": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot Chat in the IDE.", - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat in the IDE." + ], + "type": [ + "null", + "object" + ] + }, + "rules": { + "type": "array", + "items": { + "title": "Repository Rule", + "type": "object", + "description": "A repository rule.", + "oneOf": [ + { + "title": "creation", + "description": "Only allow users with bypass permission to create matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "creation" + ] + } + } }, - "editors": { - "type": "array", - "items": { - "type": "object", - "description": "Copilot Chat metrics, for active editors.", - "properties": { - "name": { - "type": "string", - "description": "Name of the given editor." + { + "title": "update", + "description": "Only allow users with bypass permission to update matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "update" + ] + }, + "parameters": { + "type": "object", + "properties": { + "update_allows_fetch_and_merge": { + "type": "boolean", + "description": "Branch can pull changes from its upstream repository" + } }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who prompted Copilot Chat in the specified editor." + "required": [ + "update_allows_fetch_and_merge" + ] + } + } + }, + { + "title": "deletion", + "description": "Only allow users with bypass permissions to delete matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "deletion" + ] + } + } + }, + { + "title": "required_linear_history", + "description": "Prevent merge commits from being pushed to matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_linear_history" + ] + } + } + }, + { + "title": "merge_queue", + "description": "Merges must be performed via a merge queue.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "merge_queue" + ] + }, + "parameters": { + "type": "object", + "properties": { + "check_response_timeout_minutes": { + "type": "integer", + "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", + "minimum": 1, + "maximum": 360 + }, + "grouping_strategy": { + "type": "string", + "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", + "enum": [ + "ALLGREEN", + "HEADGREEN" + ] + }, + "max_entries_to_build": { + "type": "integer", + "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", + "minimum": 0, + "maximum": 100 + }, + "max_entries_to_merge": { + "type": "integer", + "description": "The maximum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "merge_method": { + "type": "string", + "description": "Method to use when merging changes from queued pull requests.", + "enum": [ + "MERGE", + "SQUASH", + "REBASE" + ] + }, + "min_entries_to_merge": { + "type": "integer", + "description": "The minimum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "min_entries_to_merge_wait_minutes": { + "type": "integer", + "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", + "minimum": 0, + "maximum": 360 + } }, - "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", - "null" - ], - "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." + "required": [ + "check_response_timeout_minutes", + "grouping_strategy", + "max_entries_to_build", + "max_entries_to_merge", + "merge_method", + "min_entries_to_merge", + "min_entries_to_merge_wait_minutes" + ] + } + } + }, + { + "title": "required_deployments", + "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_deployments" + ] + }, + "parameters": { + "type": "object", + "properties": { + "required_deployment_environments": { + "type": "array", + "description": "The environments that must be successfully deployed to before branches can be merged.", + "items": { + "type": "string" + } + } + }, + "required": [ + "required_deployment_environments" + ] + } + } + }, + { + "title": "required_signatures", + "description": "Commits pushed to matching refs must have verified signatures.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_signatures" + ] + } + } + }, + { + "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.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "pull_request" + ] + }, + "parameters": { + "type": "object", + "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", + "items": { + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "automatic_copilot_code_review_enabled": { + "type": "boolean", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean", + "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." + }, + "require_code_owner_review": { + "type": "boolean", + "description": "Require an approving review in pull requests that modify files that have a designated code owner." + }, + "require_last_push_approval": { + "type": "boolean", + "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." + }, + "required_approving_review_count": { + "type": "integer", + "description": "The number of approving reviews that are required before a pull request can be merged.", + "minimum": 0, + "maximum": 10 + }, + "required_review_thread_resolution": { + "type": "boolean", + "description": "All conversations on code must be resolved before a pull request can be merged." + } + }, + "required": [ + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "require_last_push_approval", + "required_approving_review_count", + "required_review_thread_resolution" + ] + } + } + }, + { + "title": "required_status_checks", + "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_status_checks" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "required_status_checks": { + "type": "array", + "description": "Status checks that are required.", + "items": { + "title": "StatusCheckConfiguration", + "description": "Required status check", + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "The status check context name that must be present on the commit." + }, + "integration_id": { + "type": "integer", + "description": "The optional integration ID that this status check must originate from." + } }, - "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." - } + "required": [ + "context" + ] } + }, + "strict_required_status_checks_policy": { + "type": "boolean", + "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." } - } + }, + "required": [ + "required_status_checks", + "strict_required_status_checks_policy" + ] } } - } - } - }, - "copilot_dotcom_chat": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot Chat in GitHub.com", - "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'." + { + "title": "non_fast_forward", + "description": "Prevent users with push access from force pushing to refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "non_fast_forward" + ] + } + } + }, + { + "title": "commit_message_pattern", + "description": "Parameters to be used for the commit_message_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_message_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "commit_author_email_pattern", + "description": "Parameters to be used for the commit_author_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_author_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } }, - "custom_model_training_date": { - "type": [ - "string", - "null" - ], - "description": "The training date for the custom model (if applicable)." + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "committer_email_pattern", + "description": "Parameters to be used for the committer_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "committer_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } }, - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "branch_name_pattern", + "description": "Parameters to be used for the branch_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "branch_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } }, - "total_chats": { - "type": "integer", - "description": "Total number of chats initiated by users on github.com." - } + "required": [ + "operator", + "pattern" + ] } } - } - } - }, - "copilot_dotcom_pull_requests": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot for pull requests.", - "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" + { + "title": "tag_name_pattern", + "description": "Parameters to be used for the tag_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tag_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } }, - "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", - "null" - ], - "description": "The training date for the custom model." + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } + }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } }, - "total_pr_summaries_created": { - "type": "integer", - "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } }, - "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": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] } } - } + }, + "required": [ + "code_scanning_tools" + ] } } } - } + ] } }, - "required": [ - "date" - ], - "additionalProperties": true + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } } }, "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 - } + "value": { + "id": 21, + "name": "super cool ruleset", + "target": "branch", + "source_type": "Organization", + "source": "my-org", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" ], - "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 - } - ] - } + "exclude": [ + "refs/heads/dev*" ] }, - "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 - } - ] + "repository_name": { + "include": [ + "important_repository", + "another_important_repository" + ], + "exclude": [ + "unimportant_repository" + ], + "protected": true + } + }, + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" + } + } + ], + "node_id": "RRS_lACkVXNlcgQB", + "_links": { + "self": { + "href": "https://api.github.com/orgs/my-org/rulesets/21" }, - "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 - } - ] - } - ] + "html": { + "href": "https://github.com/organizations/my-org/settings/rules/21" } - } - ] + }, + "created_at": "2023-08-15T08:43:03Z", + "updated_at": "2023-09-23T16:29:47Z" + } } } } } }, - "500": { - "description": "Internal Error", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -164115,60 +157653,8 @@ } } }, - "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.", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -164193,26 +157679,24 @@ } } } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-metrics" } - } - }, - "/orgs/{org}/teams": { - "get": { - "summary": "List teams", - "description": "Lists all teams in an organization that are visible to the authenticated user.", + }, + "put": { + "summary": "Update an organization repository ruleset", + "description": "Update a ruleset for an organization.", "tags": [ - "teams" + "repos" ], - "operationId": "teams/list", + "operationId": "repos/update-org-ruleset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#list-teams" + "url": "https://docs.github.com/rest/orgs/rules#update-an-organization-repository-ruleset" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "rules" }, "parameters": [ { @@ -164225,1126 +157709,2456 @@ } }, { - "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": "ruleset_id", + "description": "The ID of the ruleset.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" } } ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", + "requestBody": { + "description": "Request body", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the ruleset." + }, + "target": { + "type": "string", + "description": "The target of the ruleset", + "enum": [ + "branch", + "tag", + "push", + "repository" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).", + "enum": [ + "disabled", + "active", + "evaluate" + ] + }, + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "title": "Repository Ruleset Bypass Actor", + "type": "object", + "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_type" + ], + "properties": { + "actor_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + }, + "actor_type": { + "type": "string", + "enum": [ + "Integration", + "OrganizationAdmin", + "RepositoryRole", + "Team", + "DeployKey" + ], + "description": "The type of actor that can bypass a ruleset." + }, + "bypass_mode": { + "type": "string", + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", + "enum": [ + "always", + "pull_request" + ], + "default": "always" + } + } + } + }, + "conditions": { + "title": "Organization ruleset conditions", "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", + "oneOf": [ + { "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" + "title": "repository_name_and_ref_name", + "description": "Conditions to target repositories by name and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } }, - "admin": { - "type": "boolean" + { + "title": "Repository ruleset conditions for repository names", + "type": "object", + "description": "Parameters for a repository name condition", + "properties": { + "repository_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + }, + "protected": { + "type": "boolean", + "description": "Whether renaming of target repositories is prevented." + } + } + } + }, + "required": [ + "repository_name" + ] } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" ] }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" + { + "type": "object", + "title": "repository_id_and_ref_name", + "description": "Conditions to target repositories by id and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Repository ruleset conditions for repository IDs", + "type": "object", + "description": "Parameters for a repository ID condition", + "properties": { + "repository_id": { + "type": "object", + "properties": { + "repository_ids": { + "type": "array", + "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" + } + } + } + } + }, + "required": [ + "repository_id" + ] + } ] }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ + { + "type": "object", + "title": "repository_property_and_ref_name", + "description": "Conditions to target repositories by property and refs by name", + "allOf": [ { - "type": "null" + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } }, { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", + "title": "Repository ruleset conditions for repository properties", "type": "object", + "description": "Parameters for a repository property condition", "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + } + } } }, "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" + "repository_property" ] } ] } - }, - "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" - } - } - } - }, - "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": "teams", - "subcategory": "teams" - } - }, - "post": { - "summary": "Create a team", - "description": "To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://docs.github.com/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/about-teams)\".", - "tags": [ - "teams" - ], - "operationId": "teams/create", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#create-a-team" - }, - "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 team." - }, - "description": { - "type": "string", - "description": "The description of the team." - }, - "maintainers": { - "type": "array", - "description": "List GitHub usernames for organization members who will become team maintainers.", - "items": { - "type": "string" - } }, - "repo_names": { + "rules": { + "description": "An array of rules within the ruleset.", "type": "array", - "description": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.", "items": { - "type": "string" - } - }, - "privacy": { - "type": "string", - "description": "The level of privacy this team should have. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \nDefault: `secret` \n**For a parent or child team:** \n * `closed` - visible to all members of this organization. \nDefault for child team: `closed`", - "enum": [ - "secret", - "closed" - ] - }, - "notification_setting": { - "type": "string", - "description": "The notification setting the team has chosen. The options are: \n * `notifications_enabled` - team members receive notifications when the team is @mentioned. \n * `notifications_disabled` - no one receives notifications. \nDefault: `notifications_enabled`", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ] - }, - "permission": { - "type": "string", - "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.", - "enum": [ - "pull", - "push" - ], - "default": "pull" - }, - "parent_team_id": { - "type": "integer", - "description": "The ID of a team to set as the parent team." - } - }, - "required": [ - "name" - ] - }, - "examples": { - "default": { - "value": { - "name": "Justice League", - "description": "A great team", - "permission": "push", - "notification_setting": "notifications_enabled", - "privacy": "closed" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Full Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Developers" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ], - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ], - "examples": [ - "notifications_enabled" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "push" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "parent": { - "anyOf": [ + "title": "Repository Rule", + "type": "object", + "description": "A repository rule.", + "oneOf": [ { - "type": "null" + "title": "creation", + "description": "Only allow users with bypass permission to create matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "creation" + ] + } + } }, { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", + "title": "update", + "description": "Only allow users with bypass permission to update matching refs.", "type": "object", + "required": [ + "type" + ], "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 + "type": { + "type": "string", + "enum": [ + "update" ] }, - "node_id": { + "parameters": { + "type": "object", + "properties": { + "update_allows_fetch_and_merge": { + "type": "boolean", + "description": "Branch can pull changes from its upstream repository" + } + }, + "required": [ + "update_allows_fetch_and_merge" + ] + } + } + }, + { + "title": "deletion", + "description": "Only allow users with bypass permissions to delete matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "examples": [ - "MDQ6VGVhbTE=" + "enum": [ + "deletion" + ] + } + } + }, + { + "title": "required_linear_history", + "description": "Prevent merge commits from being pushed to matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_linear_history" + ] + } + } + }, + { + "title": "required_deployments", + "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_deployments" ] }, - "url": { - "description": "URL for the team", + "parameters": { + "type": "object", + "properties": { + "required_deployment_environments": { + "type": "array", + "description": "The environments that must be successfully deployed to before branches can be merged.", + "items": { + "type": "string" + } + } + }, + "required": [ + "required_deployment_environments" + ] + } + } + }, + { + "title": "required_signatures", + "description": "Commits pushed to matching refs must have verified signatures.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" + "enum": [ + "required_signatures" + ] + } + } + }, + { + "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.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "pull_request" ] }, - "members_url": { + "parameters": { + "type": "object", + "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", + "items": { + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "automatic_copilot_code_review_enabled": { + "type": "boolean", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean", + "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." + }, + "require_code_owner_review": { + "type": "boolean", + "description": "Require an approving review in pull requests that modify files that have a designated code owner." + }, + "require_last_push_approval": { + "type": "boolean", + "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." + }, + "required_approving_review_count": { + "type": "integer", + "description": "The number of approving reviews that are required before a pull request can be merged.", + "minimum": 0, + "maximum": 10 + }, + "required_review_thread_resolution": { + "type": "boolean", + "description": "All conversations on code must be resolved before a pull request can be merged." + } + }, + "required": [ + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "require_last_push_approval", + "required_approving_review_count", + "required_review_thread_resolution" + ] + } + } + }, + { + "title": "required_status_checks", + "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" + "enum": [ + "required_status_checks" ] }, - "name": { - "description": "Name of the team", + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "required_status_checks": { + "type": "array", + "description": "Status checks that are required.", + "items": { + "title": "StatusCheckConfiguration", + "description": "Required status check", + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "The status check context name that must be present on the commit." + }, + "integration_id": { + "type": "integer", + "description": "The optional integration ID that this status check must originate from." + } + }, + "required": [ + "context" + ] + } + }, + "strict_required_status_checks_policy": { + "type": "boolean", + "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." + } + }, + "required": [ + "required_status_checks", + "strict_required_status_checks_policy" + ] + } + } + }, + { + "title": "non_fast_forward", + "description": "Prevent users with push access from force pushing to refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "examples": [ - "Justice League" + "enum": [ + "non_fast_forward" + ] + } + } + }, + { + "title": "commit_message_pattern", + "description": "Parameters to be used for the commit_message_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_message_pattern" ] }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "commit_author_email_pattern", + "description": "Parameters to be used for the commit_author_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_author_email_pattern" ] }, - "permission": { - "description": "Permission that the team will have for its repositories", + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "committer_email_pattern", + "description": "Parameters to be used for the committer_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "examples": [ - "admin" + "enum": [ + "committer_email_pattern" ] }, - "privacy": { - "description": "The level of privacy this team should have", + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "branch_name_pattern", + "description": "Parameters to be used for the branch_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "examples": [ - "closed" + "enum": [ + "branch_name_pattern" ] }, - "notification_setting": { - "description": "The notification setting the team has set", + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "tag_name_pattern", + "description": "Parameters to be used for the tag_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "examples": [ - "notifications_enabled" + "enum": [ + "tag_name_pattern" ] }, - "html_url": { + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" + "enum": [ + "file_path_restriction" ] }, - "repositories_url": { + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" + "enum": [ + "max_file_path_length" ] }, - "slug": { + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "examples": [ - "justice-league" + "enum": [ + "file_extension_restriction" ] }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" ] } - }, + } + }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } } ] + } + } + } + }, + "examples": { + "default": { + "value": { + "name": "super cool ruleset", + "target": "branch", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] + }, + "repository_name": { + "include": [ + "important_repository", + "another_important_repository" + ], + "exclude": [ + "unimportant_repository" + ], + "protected": true + } }, - "members_count": { + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" + } + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Repository ruleset", + "type": "object", + "description": "A set of rules to apply when specified conditions are met.", + "required": [ + "id", + "name", + "source", + "enforcement" + ], + "properties": { + "id": { "type": "integer", - "examples": [ - 3 + "description": "The ID of the ruleset" + }, + "name": { + "type": "string", + "description": "The name of the ruleset" + }, + "target": { + "type": "string", + "description": "The target of the ruleset", + "enum": [ + "branch", + "tag", + "push", + "repository" ] }, - "repos_count": { - "type": "integer", - "examples": [ - 10 + "source_type": { + "type": "string", + "description": "The type of the source of the ruleset", + "enum": [ + "Repository", + "Organization", + "Enterprise" ] }, - "created_at": { + "source": { "type": "string", - "format": "date-time", - "examples": [ - "2017-07-14T16:53:42Z" + "description": "The name of the source" + }, + "enforcement": { + "type": "string", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).", + "enum": [ + "disabled", + "active", + "evaluate" ] }, - "updated_at": { + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "title": "Repository Ruleset Bypass Actor", + "type": "object", + "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_type" + ], + "properties": { + "actor_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + }, + "actor_type": { + "type": "string", + "enum": [ + "Integration", + "OrganizationAdmin", + "RepositoryRole", + "Team", + "DeployKey" + ], + "description": "The type of actor that can bypass a ruleset." + }, + "bypass_mode": { + "type": "string", + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", + "enum": [ + "always", + "pull_request" + ], + "default": "always" + } + } + } + }, + "current_user_can_bypass": { "type": "string", - "format": "date-time", - "examples": [ - "2017-08-17T12:37:15Z" + "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", + "enum": [ + "always", + "pull_requests_only", + "never" ] }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", + "node_id": { + "type": "string" + }, + "_links": { "type": "object", "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - }, - "name": { - "type": "string", - "examples": [ - "github" - ] - }, - "company": { - "type": "string", - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": "string", - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": "string", - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "github" - ] - }, - "is_verified": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_organization_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_repository_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "private_gists": { - "type": [ - "integer", - "null" - ], - "examples": [ - 81 - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ], - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ], - "examples": [ - 8 - ] + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "The URL of the ruleset" + } + } }, - "billing_email": { + "html": { "type": [ - "string", + "object", "null" ], - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "plan": { - "type": "object", "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" + "href": { + "type": "string", + "description": "The html URL of the ruleset" } - }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": [ - "string", - "null" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "members_allowed_repository_creation_type": { - "type": "string", - "examples": [ - "all" - ] - }, - "members_can_create_public_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_public_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] + } + } + } + }, + "conditions": { + "anyOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false + { + "title": "Organization ruleset conditions", + "type": "object", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", + "oneOf": [ + { + "type": "object", + "title": "repository_name_and_ref_name", + "description": "Conditions to target repositories by name and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Repository ruleset conditions for repository names", + "type": "object", + "description": "Parameters for a repository name condition", + "properties": { + "repository_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + }, + "protected": { + "type": "boolean", + "description": "Whether renaming of target repositories is prevented." + } + } + } + }, + "required": [ + "repository_name" + ] + } + ] + }, + { + "type": "object", + "title": "repository_id_and_ref_name", + "description": "Conditions to target repositories by id and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Repository ruleset conditions for repository IDs", + "type": "object", + "description": "Parameters for a repository ID condition", + "properties": { + "repository_id": { + "type": "object", + "properties": { + "repository_ids": { + "type": "array", + "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" + } + } + } + } + }, + "required": [ + "repository_id" + ] + } + ] + }, + { + "type": "object", + "title": "repository_property_and_ref_name", + "description": "Conditions to target repositories by property and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Repository ruleset conditions for repository properties", + "type": "object", + "description": "Parameters for a repository property condition", + "properties": { + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + } + } + } + }, + "required": [ + "repository_property" + ] + } + ] + } ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" } - }, - "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" + ], + "type": [ + "null", + "object" ] }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "rules": { + "type": "array", + "items": { + "title": "Repository Rule", + "type": "object", + "description": "A repository rule.", + "oneOf": [ + { + "title": "creation", + "description": "Only allow users with bypass permission to create matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "creation" + ] + } + } + }, + { + "title": "update", + "description": "Only allow users with bypass permission to update matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "update" + ] + }, + "parameters": { + "type": "object", + "properties": { + "update_allows_fetch_and_merge": { + "type": "boolean", + "description": "Branch can pull changes from its upstream repository" + } + }, + "required": [ + "update_allows_fetch_and_merge" + ] + } + } + }, + { + "title": "deletion", + "description": "Only allow users with bypass permissions to delete matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "deletion" + ] + } + } + }, + { + "title": "required_linear_history", + "description": "Prevent merge commits from being pushed to matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_linear_history" + ] + } + } + }, + { + "title": "merge_queue", + "description": "Merges must be performed via a merge queue.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "merge_queue" + ] + }, + "parameters": { + "type": "object", + "properties": { + "check_response_timeout_minutes": { + "type": "integer", + "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", + "minimum": 1, + "maximum": 360 + }, + "grouping_strategy": { + "type": "string", + "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", + "enum": [ + "ALLGREEN", + "HEADGREEN" + ] + }, + "max_entries_to_build": { + "type": "integer", + "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", + "minimum": 0, + "maximum": 100 + }, + "max_entries_to_merge": { + "type": "integer", + "description": "The maximum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "merge_method": { + "type": "string", + "description": "Method to use when merging changes from queued pull requests.", + "enum": [ + "MERGE", + "SQUASH", + "REBASE" + ] + }, + "min_entries_to_merge": { + "type": "integer", + "description": "The minimum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "min_entries_to_merge_wait_minutes": { + "type": "integer", + "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", + "minimum": 0, + "maximum": 360 + } + }, + "required": [ + "check_response_timeout_minutes", + "grouping_strategy", + "max_entries_to_build", + "max_entries_to_merge", + "merge_method", + "min_entries_to_merge", + "min_entries_to_merge_wait_minutes" + ] + } + } + }, + { + "title": "required_deployments", + "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_deployments" + ] + }, + "parameters": { + "type": "object", + "properties": { + "required_deployment_environments": { + "type": "array", + "description": "The environments that must be successfully deployed to before branches can be merged.", + "items": { + "type": "string" + } + } + }, + "required": [ + "required_deployment_environments" + ] + } + } + }, + { + "title": "required_signatures", + "description": "Commits pushed to matching refs must have verified signatures.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_signatures" + ] + } + } + }, + { + "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.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "pull_request" + ] + }, + "parameters": { + "type": "object", + "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", + "items": { + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "automatic_copilot_code_review_enabled": { + "type": "boolean", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean", + "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." + }, + "require_code_owner_review": { + "type": "boolean", + "description": "Require an approving review in pull requests that modify files that have a designated code owner." + }, + "require_last_push_approval": { + "type": "boolean", + "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." + }, + "required_approving_review_count": { + "type": "integer", + "description": "The number of approving reviews that are required before a pull request can be merged.", + "minimum": 0, + "maximum": 10 + }, + "required_review_thread_resolution": { + "type": "boolean", + "description": "All conversations on code must be resolved before a pull request can be merged." + } + }, + "required": [ + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "require_last_push_approval", + "required_approving_review_count", + "required_review_thread_resolution" + ] + } + } + }, + { + "title": "required_status_checks", + "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_status_checks" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "required_status_checks": { + "type": "array", + "description": "Status checks that are required.", + "items": { + "title": "StatusCheckConfiguration", + "description": "Required status check", + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "The status check context name that must be present on the commit." + }, + "integration_id": { + "type": "integer", + "description": "The optional integration ID that this status check must originate from." + } + }, + "required": [ + "context" + ] + } + }, + "strict_required_status_checks_policy": { + "type": "boolean", + "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." + } + }, + "required": [ + "required_status_checks", + "strict_required_status_checks_policy" + ] + } + } + }, + { + "title": "non_fast_forward", + "description": "Prevent users with push access from force pushing to refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "non_fast_forward" + ] + } + } + }, + { + "title": "commit_message_pattern", + "description": "Parameters to be used for the commit_message_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_message_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "commit_author_email_pattern", + "description": "Parameters to be used for the commit_author_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_author_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "committer_email_pattern", + "description": "Parameters to be used for the committer_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "committer_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "branch_name_pattern", + "description": "Parameters to be used for the branch_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "branch_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "tag_name_pattern", + "description": "Parameters to be used for the tag_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tag_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } + }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + } + ] + } + }, + "created_at": { "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "created_at", - "updated_at", - "members_count", - "repos_count", - "organization" - ] + } }, "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, - "members_count": 3, - "repos_count": 10, - "created_at": "2017-07-14T16:53:42Z", - "updated_at": "2017-08-17T12:37:15Z", - "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", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "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", - "updated_at": "2017-08-17T12:37:15Z", - "type": "Organization" - } + "id": 21, + "name": "super cool ruleset", + "target": "branch", + "source_type": "Organization", + "source": "my-org", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] + }, + "repository_name": { + "include": [ + "important_repository", + "another_important_repository" + ], + "exclude": [ + "unimportant_repository" + ], + "protected": true + } + }, + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" + } + } + ], + "node_id": "RRS_lACkVXNlcgQB", + "_links": { + "self": { + "href": "https://api.github.com/orgs/my-org/rulesets/21" + }, + "html": { + "href": "https://github.com/organizations/my-org/settings/rules/21" + } + }, + "created_at": "2023-08-15T08:43:03Z", + "updated_at": "2023-09-23T16:29:47Z" } } } } } }, - "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" @@ -165352,64 +160166,19 @@ "documentation_url": { "type": "string" }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } }, - "403": { - "description": "Forbidden", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -165434,26 +160203,115 @@ } } } + } + }, + "delete": { + "summary": "Delete an organization repository ruleset", + "description": "Delete a ruleset for an organization.", + "tags": [ + "repos" + ], + "operationId": "repos/delete-org-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/rules#delete-an-organization-repository-ruleset" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams" + "category": "orgs", + "subcategory": "rules" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ruleset_id", + "description": "The ID of the ruleset.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "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" + } + } + } + } + } + }, + "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" + } + } + } + } + } + } } } }, - "/orgs/{org}/teams/{team_slug}": { + "/orgs/{org}/rulesets/{ruleset_id}/history": { "get": { - "summary": "Get a team by name", - "description": "Gets a team using the team's `slug`. To create the `slug`, GitHub replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `\"My TEam Näme\"` would become `my-team-name`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`.", + "summary": "Get organization ruleset history", + "description": "Get the history of an organization ruleset.", "tags": [ - "teams" + "orgs" ], - "operationId": "teams/get-by-name", + "operationId": "orgs/get-org-ruleset-history", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#get-a-team-by-name" + "url": "https://docs.github.com/rest/orgs/rules#get-organization-ruleset-history" }, "parameters": [ { @@ -165466,12 +160324,30 @@ } }, { - "name": "team_slug", - "description": "The slug of the team name.", + "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": "ruleset_id", + "description": "The ID of the ruleset.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], @@ -165481,709 +160357,318 @@ "content": { "application/json": { "schema": { - "title": "Full Team", - "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "array", + "items": { + "title": "Ruleset version", + "type": "object", + "description": "The historical version of a ruleset", + "required": [ + "version_id", + "actor", + "updated_at" + ], + "properties": { + "version_id": { + "type": "integer", + "description": "The ID of the previous version of the ruleset" + }, + "actor": { + "type": "object", + "description": "The actor who updated the ruleset", + "properties": { + "id": { + "type": "integer" + }, + "type": { + "type": "string" + } + } + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + } + }, + "examples": { + "default": { + "value": [ + { + "version_id": 3, + "actor": { + "id": 1, + "type": "User" + }, + "updated_at": "2024-010-23T16:29:47Z" + }, + { + "version_id": 2, + "actor": { + "id": 2, + "type": "User" + }, + "updated_at": "2024-09-23T16:29:47Z" + }, + { + "version_id": 1, + "actor": { + "id": 1, + "type": "User" + }, + "updated_at": "2024-08-23T16:29:47Z" + } + ] + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 42 - ] + "message": { + "type": "string" }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] + "documentation_url": { + "type": "string" }, "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Developers" - ] + "type": "string" }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] + "status": { + "type": "string" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] + "documentation_url": { + "type": "string" }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ], - "examples": [ - "closed" - ] + "url": { + "type": "string" }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "enum": [ - "notifications_enabled", - "notifications_disabled" + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "rules" + } + } + }, + "/orgs/{org}/rulesets/{ruleset_id}/history/{version_id}": { + "get": { + "summary": "Get organization ruleset version", + "description": "Get a version of an organization ruleset.", + "tags": [ + "orgs" + ], + "operationId": "orgs/get-org-ruleset-version", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/rules#get-organization-ruleset-version" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ruleset_id", + "description": "The ID of the ruleset.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "version_id", + "description": "The ID of the version", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "title": "Ruleset version", + "type": "object", + "description": "The historical version of a ruleset", + "required": [ + "version_id", + "actor", + "updated_at" ], - "examples": [ - "notifications_enabled" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "push" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "parent": { - "anyOf": [ - { - "type": "null" + "properties": { + "version_id": { + "type": "integer", + "description": "The ID of the previous version of the ruleset" }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", + "actor": { "type": "object", + "description": "The actor who updated the ruleset", "properties": { "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] + "type": "integer" }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" + "type": { + "type": "string" + } + } + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + { + "type": "object", + "required": [ + "state" + ], + "properties": { + "state": { + "type": "object", + "description": "The state of the ruleset version" + } + } + } + ] + }, + "examples": { + "default": { + "value": [ + { + "version_id": 3, + "actor": { + "id": 1, + "type": "User" + }, + "updated_at": "2024-010-23T16:29:47Z", + "state": { + "id": 21, + "name": "super cool ruleset", + "target": "branch", + "source_type": "Organization", + "source": "my-org", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" + "exclude": [ + "refs/heads/dev*" ] }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] + "repository_name": { + "include": [ + "important_repository", + "another_important_repository" + ], + "exclude": [ + "unimportant_repository" + ], + "protected": true } }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" + } + } ] } - ] - }, - "members_count": { - "type": "integer", - "examples": [ - 3 - ] - }, - "repos_count": { - "type": "integer", - "examples": [ - 10 - ] + } + ] + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-14T16:53:42Z" - ] + "documentation_url": { + "type": "string" }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-08-17T12:37:15Z" - ] + "url": { + "type": "string" }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - }, - "name": { - "type": "string", - "examples": [ - "github" - ] - }, - "company": { - "type": "string", - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": "string", - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": "string", - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "github" - ] - }, - "is_verified": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_organization_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_repository_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "private_gists": { - "type": [ - "integer", - "null" - ], - "examples": [ - 81 - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ], - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ], - "examples": [ - 8 - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } - }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": [ - "string", - "null" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "members_allowed_repository_creation_type": { - "type": "string", - "examples": [ - "all" - ] - }, - "members_can_create_public_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_public_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "created_at", - "updated_at", - "members_count", - "repos_count", - "organization" - ] - }, - "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, - "members_count": 3, - "repos_count": 10, - "created_at": "2017-07-14T16:53:42Z", - "updated_at": "2017-08-17T12:37:15Z", - "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", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "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", - "updated_at": "2017-08-17T12:37:15Z", - "type": "Organization" - } + "status": { + "type": "string" } } } } } }, - "404": { - "description": "Resource not found", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -166212,20 +160697,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams" + "category": "orgs", + "subcategory": "rules" } - }, - "patch": { - "summary": "Update a team", - "description": "To edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`.", + } + }, + "/orgs/{org}/secret-scanning/alerts": { + "get": { + "summary": "List secret scanning alerts for an organization", + "description": "Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.\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 `repo` or `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": [ - "teams" + "secret-scanning" ], - "operationId": "teams/update-in-org", + "operationId": "secret-scanning/list-alerts-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#update-a-team" + "url": "https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization" }, "parameters": [ { @@ -166238,1756 +160725,1150 @@ } }, { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, + "name": "state", + "in": "query", + "description": "Set to `open` or `resolved` to only list secret scanning alerts in a specific state.", + "required": false, + "schema": { + "type": "string", + "enum": [ + "open", + "resolved" + ] + } + }, + { + "name": "secret_type", + "in": "query", + "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", + "required": false, "schema": { "type": "string" } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the team." - }, - "description": { - "type": "string", - "description": "The description of the team." - }, - "privacy": { - "type": "string", - "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \n**For a parent or child team:** \n * `closed` - visible to all members of this organization.", - "enum": [ - "secret", - "closed" - ] - }, - "notification_setting": { - "type": "string", - "description": "The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: \n * `notifications_enabled` - team members receive notifications when the team is @mentioned. \n * `notifications_disabled` - no one receives notifications.", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ] - }, - "permission": { - "type": "string", - "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.", - "enum": [ - "pull", - "push", - "admin" - ], - "default": "pull" - }, - "parent_team_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of a team to set as the parent team." - } - } - }, - "examples": { - "default": { - "value": { - "name": "new team name", - "description": "new team description", - "privacy": "closed", - "notification_setting": "notifications_enabled" - } - } - } + }, + { + "name": "resolution", + "in": "query", + "description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.", + "required": false, + "schema": { + "type": "string" + } + }, + { + "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.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated" + ], + "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": "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": "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 receive an initial cursor on your first request, include an empty \"before\" query string.", + "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 events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "validity", + "in": "query", + "description": "A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`.", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "is_publicly_leaked", + "in": "query", + "description": "A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present.", + "required": false, + "schema": { + "type": "boolean", + "default": false + } + }, + { + "name": "is_multi_repo", + "in": "query", + "description": "A boolean value representing whether or not to filter alerts by the multi-repo tag being present.", + "required": false, + "schema": { + "type": "boolean", + "default": false + } + }, + { + "name": "hide_secret", + "in": "query", + "description": "A boolean value representing whether or not to hide literal secrets in the results.", + "required": false, + "schema": { + "type": "boolean", + "default": false } } - }, + ], "responses": { "200": { - "description": "Response when the updated information already exists", + "description": "Response", "content": { "application/json": { "schema": { - "title": "Full Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Developers" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ], - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ], - "examples": [ - "notifications_enabled" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "push" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] - } - ] - }, - "members_count": { - "type": "integer", - "examples": [ - 3 - ] - }, - "repos_count": { - "type": "integer", - "examples": [ - 10 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-14T16:53:42Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-08-17T12:37:15Z" - ] - }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - }, - "name": { - "type": "string", - "examples": [ - "github" - ] - }, - "company": { - "type": "string", - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": "string", - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": "string", - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "github" - ] - }, - "is_verified": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_organization_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_repository_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "private_gists": { - "type": [ - "integer", - "null" - ], - "examples": [ - 81 - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ], - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ], - "examples": [ - 8 - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } + "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": { + "anyOf": [ + { + "type": "null" }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": [ - "string", - "null" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "members_allowed_repository_creation_type": { - "type": "string", - "examples": [ - "all" - ] - }, - "members_can_create_public_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_public_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } + { + "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 + } + ] }, - "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" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "created_at", - "updated_at", - "members_count", - "repos_count", - "organization" - ] - }, - "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, - "members_count": 3, - "repos_count": 10, - "created_at": "2017-07-14T16:53:42Z", - "updated_at": "2017-08-17T12:37:15Z", - "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", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "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", - "updated_at": "2017-08-17T12:37:15Z", - "type": "Organization" - } - } - } - } - } - } - }, - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Full Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Developers" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ], - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "enum": [ - "notifications_enabled", - "notifications_disabled" - ], - "examples": [ - "notifications_enabled" - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "push" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] + "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 + }, + "locations_url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the code locations for this alert." + }, + "state": { + "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": { + "type": [ + "string", + "null" + ], + "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + null + ] + }, + "resolved_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "resolved_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "secret_type_display_name": { + "type": "string", + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + }, + "secret": { + "type": "string", + "description": "The secret that was detected." + }, + "repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "A unique identifier of the repository.", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository.", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "description": "The name of the repository.", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository.", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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" - ] - } - ] - }, - "members_count": { - "type": "integer", - "examples": [ - 3 - ] - }, - "repos_count": { - "type": "integer", - "examples": [ - 10 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-14T16:53:42Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-08-17T12:37:15Z" - ] - }, - "organization": { - "title": "Team Organization", - "description": "Team Organization", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - }, - "name": { - "type": "string", - "examples": [ - "github" - ] - }, - "company": { - "type": "string", - "examples": [ - "GitHub" - ] - }, - "blog": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/blog" - ] - }, - "location": { - "type": "string", - "examples": [ - "San Francisco" - ] - }, - "email": { - "type": "string", - "format": "email", - "examples": [ - "octocat@github.com" - ] - }, - "twitter_username": { - "type": [ - "string", - "null" - ], - "examples": [ - "github" - ] - }, - "is_verified": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_organization_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_repository_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "public_repos": { - "type": "integer", - "examples": [ - 2 - ] - }, - "public_gists": { - "type": "integer", - "examples": [ - 1 - ] - }, - "followers": { - "type": "integer", - "examples": [ - 20 - ] - }, - "following": { - "type": "integer", - "examples": [ - 0 - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2008-01-14T04:33:35Z" - ] - }, - "type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "total_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "owned_private_repos": { - "type": "integer", - "examples": [ - 100 - ] - }, - "private_gists": { - "type": [ - "integer", - "null" - ], - "examples": [ - 81 - ] - }, - "disk_usage": { - "type": [ - "integer", - "null" - ], - "examples": [ - 10000 - ] - }, - "collaborators": { - "type": [ - "integer", - "null" - ], - "examples": [ - 8 - ] - }, - "billing_email": { - "type": [ - "string", - "null" - ], - "format": "email", - "examples": [ - "org@example.com" - ] - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } + "private": { + "type": "boolean", + "description": "Whether the repository is private." }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": [ - "string", - "null" - ] - }, - "members_can_create_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "two_factor_requirement_enabled": { - "type": [ - "boolean", - "null" - ], - "examples": [ - true - ] - }, - "members_allowed_repository_creation_type": { - "type": "string", - "examples": [ - "all" - ] - }, - "members_can_create_public_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_public_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_create_private_pages": { - "type": "boolean", - "examples": [ - true - ] - }, - "members_can_fork_private_repositories": { - "type": [ - "boolean", - "null" - ], - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "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" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "created_at", - "updated_at", - "members_count", - "repos_count", - "organization" - ] - }, - "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, - "members_count": 3, - "repos_count": 10, - "created_at": "2017-07-14T16:53:42Z", - "updated_at": "2017-08-17T12:37:15Z", - "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", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "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", - "updated_at": "2017-08-17T12:37:15Z", - "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" - } - } - } - } - } - }, - "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" + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com.", + "examples": [ + "https://github.com/octocat/Hello-World" + ] }, - "field": { - "type": "string" + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description.", + "examples": [ + "This your first repo!" + ] }, - "message": { - "type": "string" + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." }, - "code": { - "type": "string" + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] }, - "index": { - "type": "integer" + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] }, - "value": { - "oneOf": [ - { + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks" + ] + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + }, + "push_protection_bypassed": { + "type": [ + "boolean", + "null" + ], + "description": "Whether push protection was bypassed for the detected secret." + }, + "push_protection_bypassed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { "type": [ "string", "null" ] }, - { + "email": { "type": [ - "integer", + "string", "null" ] }, - { + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { "type": [ - "array", + "string", "null" ], - "items": { - "type": "string" - } + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] } - } - } - } - } - } - } - } - }, - "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": "teams", - "subcategory": "teams" - } - }, - "delete": { - "summary": "Delete a team", - "description": "To delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`.", - "tags": [ - "teams" - ], - "operationId": "teams/delete-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#delete-a-team" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams" - } - } - }, - "/orgs/{org}/teams/{team_slug}/discussions": { - "get": { - "summary": "List discussions", - "description": "List all discussions on a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", - "tags": [ - "teams" - ], - "operationId": "teams/list-discussions-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/discussions#list-discussions" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "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/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": "pinned", - "in": "query", - "required": false, - "description": "Pinned discussions only filter", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", - "type": "object", - "properties": { - "author": { + ] + }, + "push_protection_bypassed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "push_protection_bypass_request_reviewer": { "anyOf": [ { "type": "null" @@ -168162,195 +162043,530 @@ } ] }, - "body": { - "description": "The main text of the discussion.", - "type": "string", - "examples": [ - "Please suggest improvements to our workflow in comments." - ] - }, - "body_html": { - "type": "string", - "examples": [ - "

Hi! This is an area for us to collaborate as a team

" - ] - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "type": "string", - "examples": [ - "0307116bbf7ced493b8d8a346c650b71" - ] - }, - "comments_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "comments_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." }, - "last_edited_at": { + "push_protection_bypass_request_comment": { "type": [ "string", "null" ], - "format": "date-time" + "description": "An optional comment when requesting a push protection bypass." }, - "html_url": { - "type": "string", + "push_protection_bypass_request_html_url": { + "type": [ + "string", + "null" + ], "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", - "examples": [ - 42 - ] - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", - "examples": [ - true - ] + "description": "The URL to a push protection bypass request." }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", - "examples": [ - true - ] + "resolution_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment that was optionally added when this alert was closed" }, - "team_url": { + "validity": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027" + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" ] }, - "title": { - "description": "The title of the discussion.", - "type": "string", - "examples": [ - "How can we improve our workflow?" - ] + "publicly_leaked": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the secret was publicly leaked." }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] + "multi_repo": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was found in multiple repositories in the same organization or enterprise." }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" - ] + "is_base64_encoded": { + "type": [ + "boolean", + "null" + ], + "description": "A boolean value representing whether or not alert is base64 encoded" }, - "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" + "first_location_detected": { + "anyOf": [ + { + "type": "null" }, - "rocket": { - "type": "integer" + { + "description": "Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request.\n", + "oneOf": [ + { + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path in the repository", + "examples": [ + "/example/secrets.txt" + ] + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "examples": [ + "af5626b4a114abcb82d63db7c8082c3c4756e51b" + ] + }, + "blob_url": { + "type": "string", + "description": "The API URL to get the associated blob resource" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "examples": [ + "af5626b4a114abcb82d63db7c8082c3c4756e51b" + ] + }, + "commit_url": { + "type": "string", + "description": "The API URL to get the associated commit resource" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + { + "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.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "examples": [ + "/example/Home.md" + ] + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "examples": [ + "af5626b4a114abcb82d63db7c8082c3c4756e51b" + ] + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "examples": [ + "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + ] + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "examples": [ + "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + ] + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "examples": [ + "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + ] + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/1347" + ] + } + }, + "required": [ + "issue_title_url" + ] + }, + { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/1347" + ] + } + }, + "required": [ + "issue_body_url" + ] + }, + { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + ] + } + }, + "required": [ + "issue_comment_url" + ] + }, + { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", + "type": "object", + "properties": { + "discussion_title_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "examples": [ + "https://github.com/community/community/discussions/39082" + ] + } + }, + "required": [ + "discussion_title_url" + ] + }, + { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", + "type": "object", + "properties": { + "discussion_body_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "examples": [ + "https://github.com/community/community/discussions/39082#discussion-4566270" + ] + } + }, + "required": [ + "discussion_body_url" + ] + }, + { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", + "type": "object", + "properties": { + "discussion_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "examples": [ + "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + ] + } + }, + "required": [ + "discussion_comment_url" + ] + }, + { + "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.", + "type": "object", + "properties": { + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + ] + } + }, + "required": [ + "pull_request_title_url" + ] + }, + { + "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.", + "type": "object", + "properties": { + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + ] + } + }, + "required": [ + "pull_request_body_url" + ] + }, + { + "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.", + "type": "object", + "properties": { + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + ] + } + }, + "required": [ + "pull_request_comment_url" + ] + }, + { + "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.", + "type": "object", + "properties": { + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + ] + } + }, + "required": [ + "pull_request_review_url" + ] + }, + { + "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.", + "type": "object", + "properties": { + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + ] + } + }, + "required": [ + "pull_request_review_comment_url" + ] + } + ] } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" ] + }, + "has_more_locations": { + "type": "boolean", + "description": "A boolean value representing whether or not the token in the alert was detected in more than one location." } - }, - "required": [ - "author", - "body", - "body_html", - "body_version", - "comments_count", - "comments_url", - "created_at", - "last_edited_at", - "html_url", - "pinned", - "private", - "node_id", - "number", - "team_url", - "title", - "updated_at", - "url" - ] + } } }, "examples": { "default": { "value": [ { - "author": { + "number": 2, + "created_at": "2020-11-06T18:48:51Z", + "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2", + "html_url": "https://github.com/owner/private-repo/security/secret-scanning/2", + "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations", + "state": "resolved", + "resolution": "false_positive", + "resolved_at": "2020-11-07T02:47:13Z", + "resolved_by": { + "login": "monalisa", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://alambic.github.com/avatars/u/2?", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "site_admin": true + }, + "secret_type": "adafruit_io_key", + "secret_type_display_name": "Adafruit IO Key", + "secret": "aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX", + "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" + }, + "push_protection_bypassed_by": { + "login": "monalisa", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://alambic.github.com/avatars/u/2?", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "site_admin": true + }, + "push_protection_bypassed": true, + "push_protection_bypassed_at": "2020-11-06T21:48:51Z", + "push_protection_bypass_request_reviewer": { "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "id": 3, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://alambic.github.com/avatars/u/3?", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", @@ -168364,542 +162580,181 @@ "events_url": "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": true }, - "body": "Hi! This is an area for us to collaborate as a team.", - "body_html": "

Hi! This is an area for us to collaborate as a team

", - "body_version": "0d495416a700fb06133c612575d92bfb", - "comments_count": 0, - "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", - "created_at": "2018-01-25T18:56:31Z", - "last_edited_at": null, - "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", - "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", + "push_protection_bypass_request_reviewer_comment": "Example response", + "push_protection_bypass_request_comment": "Example comment", + "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", + "resolution_comment": "Example comment", + "validity": "active", + "publicly_leaked": false, + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "path": "/example/secrets.txt", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + }, + "has_more_locations": true + }, + { "number": 1, - "pinned": false, - "private": false, - "team_url": "https://api.github.com/teams/2343027", - "title": "Our first team post", - "updated_at": "2018-01-25T18:56:31Z", - "url": "https://api.github.com/teams/2343027/discussions/1", - "reactions": { - "url": "https://api.github.com/teams/2343027/discussions/1/reactions", - "total_count": 5, - "+1": 3, - "-1": 1, - "laugh": 0, - "confused": 0, - "heart": 1, - "hooray": 0, - "eyes": 1, - "rocket": 1 - } - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "discussions" - } - }, - "post": { - "summary": "Create a discussion", - "description": "Creates a new discussion post on a team's page.\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)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "teams" - ], - "operationId": "teams/create-discussion-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/discussions#create-a-discussion" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "The discussion post's title." - }, - "body": { - "type": "string", - "description": "The discussion post's body text." - }, - "private": { - "type": "boolean", - "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.", - "default": false - } - }, - "required": [ - "title", - "body" - ] - }, - "examples": { - "default": { - "value": { - "title": "Our first team post", - "body": "Hi! This is an area for us to collaborate as a team." + "created_at": "2020-11-06T18:18:30Z", + "url": "https://api.github.com/repos/owner/repo/secret-scanning/alerts/1", + "html_url": "https://github.com/owner/repo/security/secret-scanning/1", + "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/1/locations", + "state": "open", + "resolution": null, + "resolved_at": null, + "resolved_by": null, + "secret_type": "mailchimp_api_key", + "secret_type_display_name": "Mailchimp API Key", + "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", + "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" + }, + "push_protection_bypassed_by": null, + "push_protection_bypassed": false, + "push_protection_bypassed_at": null, + "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, + "push_protection_bypass_request_comment": null, + "push_protection_bypass_request_html_url": null, + "resolution_comment": null, + "validity": "unknown", + "publicly_leaked": false, + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "issue_title_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + }, + "has_more_locations": false + } + ] } } } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } } - } - }, - "responses": { - "201": { - "description": "Response", + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "author": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "body": { - "description": "The main text of the discussion.", - "type": "string", - "examples": [ - "Please suggest improvements to our workflow in comments." - ] - }, - "body_html": { - "type": "string", - "examples": [ - "

Hi! This is an area for us to collaborate as a team

" - ] - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "type": "string", - "examples": [ - "0307116bbf7ced493b8d8a346c650b71" - ] - }, - "comments_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "comments_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", - "examples": [ - 42 - ] - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", - "examples": [ - true - ] - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", - "examples": [ - true - ] - }, - "team_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027" - ] - }, - "title": { - "description": "The title of the discussion.", - "type": "string", - "examples": [ - "How can we improve our workflow?" - ] + "message": { + "type": "string" }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] + "documentation_url": { + "type": "string" }, "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" - ] + "type": "string" }, - "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" - ] + "status": { + "type": "string" } - }, - "required": [ - "author", - "body", - "body_html", - "body_version", - "comments_count", - "comments_url", - "created_at", - "last_edited_at", - "html_url", - "pinned", - "private", - "node_id", - "number", - "team_url", - "title", - "updated_at", - "url" - ] - }, - "examples": { - "default": { - "value": { - "author": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "body": "Hi! This is an area for us to collaborate as a team.", - "body_html": "

Hi! This is an area for us to collaborate as a team

", - "body_version": "0d495416a700fb06133c612575d92bfb", - "comments_count": 0, - "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", - "created_at": "2018-01-25T18:56:31Z", - "last_edited_at": null, - "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", - "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", - "number": 1, - "pinned": false, - "private": false, - "team_url": "https://api.github.com/teams/2343027", - "title": "Our first team post", - "updated_at": "2018-01-25T18:56:31Z", - "url": "https://api.github.com/teams/2343027/discussions/1", - "reactions": { - "url": "https://api.github.com/teams/2343027/discussions/1/reactions", - "total_count": 5, - "+1": 3, - "-1": 1, - "laugh": 0, - "confused": 0, - "heart": 1, - "hooray": 0, - "eyes": 1, - "rocket": 1 - } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" } } } @@ -168908,25 +162763,30 @@ } }, "x-github": { - "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "discussions" + "category": "secret-scanning", + "subcategory": "secret-scanning" } } }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": { + "/orgs/{org}/secret-scanning/pattern-configurations": { "get": { - "summary": "Get a discussion", - "description": "Get a specific discussion on a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "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": [ - "teams" + "secret-scanning" ], - "operationId": "teams/get-discussion-in-org", + "operationId": "secret-scanning/list-org-pattern-configs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/discussions#get-a-discussion" + "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": [ { @@ -168937,24 +162797,6 @@ "schema": { "type": "string" } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { @@ -168963,439 +162805,285 @@ "content": { "application/json": { "schema": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", + "title": "Secret scanning pattern configuration", + "description": "A collection of secret scanning patterns and their settings related to push protection.", "type": "object", "properties": { - "author": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "body": { - "description": "The main text of the discussion.", - "type": "string", - "examples": [ - "Please suggest improvements to our workflow in comments." - ] - }, - "body_html": { - "type": "string", - "examples": [ - "

Hi! This is an area for us to collaborate as a team

" - ] - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "type": "string", - "examples": [ - "0307116bbf7ced493b8d8a346c650b71" - ] - }, - "comments_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "comments_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] - }, - "last_edited_at": { + "pattern_config_version": { "type": [ "string", "null" ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - ] + "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." }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", - "examples": [ - 42 - ] + "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", + "null" + ], + "description": "The version of this pattern if it's a custom pattern." + }, + "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", + "null" + ], + "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", + null + ] + }, + "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" + ] + } + } + } }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", - "examples": [ - true + "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", + "null" + ], + "description": "The version of this pattern if it's a custom pattern." + }, + "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", + "null" + ], + "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", + null + ] + }, + "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" }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", - "examples": [ - true - ] + "documentation_url": { + "type": "string" }, - "team_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027" - ] + "url": { + "type": "string" }, - "title": { - "description": "The title of the discussion.", - "type": "string", - "examples": [ - "How can we improve our workflow?" - ] + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] + "documentation_url": { + "type": "string" }, "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" - ] + "type": "string" }, - "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": [ - "author", - "body", - "body_html", - "body_version", - "comments_count", - "comments_url", - "created_at", - "last_edited_at", - "html_url", - "pinned", - "private", - "node_id", - "number", - "team_url", - "title", - "updated_at", - "url" - ] - }, - "examples": { - "default": { - "value": { - "author": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "body": "Hi! This is an area for us to collaborate as a team.", - "body_html": "

Hi! This is an area for us to collaborate as a team

", - "body_version": "0d495416a700fb06133c612575d92bfb", - "comments_count": 0, - "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", - "created_at": "2018-01-25T18:56:31Z", - "last_edited_at": null, - "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", - "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", - "number": 1, - "pinned": false, - "private": false, - "team_url": "https://api.github.com/teams/2343027", - "title": "Our first team post", - "updated_at": "2018-01-25T18:56:31Z", - "url": "https://api.github.com/teams/2343027/discussions/1", - "reactions": { - "url": "https://api.github.com/teams/2343027/discussions/1/reactions", - "total_count": 5, - "+1": 3, - "-1": 1, - "laugh": 0, - "confused": 0, - "heart": 1, - "hooray": 0, - "eyes": 1, - "rocket": 1 - } + "status": { + "type": "string" } } } } } } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "discussions" } }, "patch": { - "summary": "Update a discussion", - "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "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": [ - "teams" + "secret-scanning" ], - "operationId": "teams/update-discussion-in-org", + "operationId": "secret-scanning/update-org-pattern-configs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/discussions#update-a-discussion" + "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": [ { @@ -169406,47 +163094,91 @@ "schema": { "type": "string" } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { - "title": { - "type": "string", - "description": "The discussion post's title." + "pattern_config_version": { + "type": [ + "string", + "null" + ], + "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." }, - "body": { - "type": "string", - "description": "The discussion post's body text." + "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", + "null" + ], + "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." + }, + "push_protection_setting": { + "type": "string", + "description": "Push protection setting to set for the pattern.", + "enum": [ + "disabled", + "enabled" + ] + } + } + } } } }, "examples": { "default": { "value": { - "title": "Welcome to our first team post" + "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" + } + ] } } } @@ -169459,414 +163191,238 @@ "content": { "application/json": { "schema": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", "type": "object", "properties": { - "author": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "body": { - "description": "The main text of the discussion.", + "pattern_config_version": { "type": "string", - "examples": [ - "Please suggest improvements to our workflow in comments." - ] + "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" }, - "body_html": { - "type": "string", - "examples": [ - "

Hi! This is an area for us to collaborate as a team

" - ] + "documentation_url": { + "type": "string" }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "type": "string", - "examples": [ - "0307116bbf7ced493b8d8a346c650b71" - ] + "url": { + "type": "string" }, - "comments_count": { - "type": "integer", - "examples": [ - 0 + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" ] }, - "comments_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + "documentation_url": { + "type": [ + "string", + "null" ] }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" + "detail": { + "type": [ + "string", + "null" ] }, - "last_edited_at": { + "status": { + "type": "integer" + }, + "scimType": { "type": [ "string", "null" - ], - "format": "date-time" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1" ] }, - "node_id": { - "type": "string", - "examples": [ - "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - ] + "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" }, - "number": { - "description": "The unique sequence number of a team discussion.", - "type": "integer", - "examples": [ - 42 - ] + "documentation_url": { + "type": "string" }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "type": "boolean", - "examples": [ - true - ] + "url": { + "type": "string" }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization owners.", - "type": "boolean", - "examples": [ - true - ] + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "team_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027" - ] + "documentation_url": { + "type": "string" }, - "title": { - "description": "The title of the discussion.", - "type": "string", - "examples": [ - "How can we improve our workflow?" - ] + "url": { + "type": "string" }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-25T18:56:31Z" - ] + "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", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2343027/discussions/1" - ] + "type": "string" }, - "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" - ] + "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": [ - "author", - "body", - "body_html", - "body_version", - "comments_count", - "comments_url", - "created_at", - "last_edited_at", - "html_url", - "pinned", - "private", - "node_id", - "number", - "team_url", - "title", - "updated_at", - "url" - ] - }, - "examples": { - "default": { - "value": { - "author": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "body": "Hi! This is an area for us to collaborate as a team.", - "body_html": "

Hi! This is an area for us to collaborate as a team

", - "body_version": "0d495416a700fb06133c612575d92bfb", - "comments_count": 1, - "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", - "created_at": "2018-01-25T18:56:31Z", - "last_edited_at": "2018-01-26T18:22:20Z", - "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", - "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", - "number": 1, - "pinned": false, - "private": false, - "team_url": "https://api.github.com/teams/2343027", - "title": "Welcome to our first team post", - "updated_at": "2018-01-26T18:22:20Z", - "url": "https://api.github.com/teams/2343027/discussions/1", - "reactions": { - "url": "https://api.github.com/teams/2343027/discussions/1/reactions", - "total_count": 5, - "+1": 3, - "-1": 1, - "laugh": 0, - "confused": 0, - "heart": 1, - "hooray": 0, - "eyes": 1, - "rocket": 1 + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } } } } @@ -169874,24 +163430,20 @@ } } } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "discussions" } - }, - "delete": { - "summary": "Delete a discussion", - "description": "Delete a discussion from a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + } + }, + "/orgs/{org}/security-advisories": { + "get": { + "summary": "List repository security advisories for an organization", + "description": "Lists repository security advisories 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 `repo` or `repository_advisories:write` scope to use this endpoint.", "tags": [ - "teams" + "security-advisories" ], - "operationId": "teams/delete-discussion-in-org", + "operationId": "security-advisories/list-org-repository-advisories", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/discussions#delete-a-discussion" + "url": "https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization" }, "parameters": [ { @@ -169904,107 +163456,77 @@ } }, { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, + "name": "direction", + "description": "The direction to sort the results by.", + "in": "query", + "required": false, "schema": { - "type": "string" + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" } }, { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "discussions" - } - } - }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": { - "get": { - "summary": "List discussion comments", - "description": "List all comments on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", - "tags": [ - "teams" - ], - "operationId": "teams/list-discussion-comments-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, + "name": "sort", + "description": "The property to sort the results by.", + "in": "query", + "required": false, "schema": { - "type": "string" + "type": "string", + "enum": [ + "created", + "updated", + "published" + ], + "default": "created" } }, { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, + "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": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "direction", - "description": "The direction to sort the results by.", + "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", - "enum": [ - "asc", - "desc" - ], - "default": "desc" + "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).\"", + "description": "The number of advisories to return per page. For more information, 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": 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": "state", + "description": "Filter by the state of the repository advisories. Only advisories of this state will be returned.", "in": "query", + "required": false, "schema": { - "type": "integer", - "default": 1 + "type": "string", + "enum": [ + "triage", + "draft", + "published", + "closed" + ] } } ], @@ -170016,15 +163538,64 @@ "schema": { "type": "array", "items": { - "title": "Team Discussion Comment", - "description": "A reply to a discussion within a team.", + "description": "A repository security advisory.", "type": "object", "properties": { + "ghsa_id": { + "type": "string", + "description": "The GitHub Security Advisory ID.", + "readOnly": true + }, + "cve_id": { + "type": [ + "string", + "null" + ], + "description": "The Common Vulnerabilities and Exposures (CVE) ID." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The API URL for the advisory.", + "readOnly": true + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL for the advisory.", + "readOnly": true + }, + "summary": { + "type": "string", + "description": "A short summary of the advisory.", + "maxLength": 1024 + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A detailed description of what the advisory entails.", + "maxLength": 65535 + }, + "severity": { + "type": [ + "string", + "null" + ], + "description": "The severity of the advisory.", + "enum": [ + "critical", + "high", + "medium", + "low", + null + ] + }, "author": { - "anyOf": [ - { - "type": "null" - }, + "readOnly": true, + "description": "The author of the advisory.", + "allOf": [ { "title": "Simple User", "description": "A GitHub user.", @@ -170193,738 +163764,748 @@ "url" ] } - ] - }, - "body": { - "description": "The main text of the comment.", - "type": "string", - "examples": [ - "I agree with this suggestion." - ] - }, - "body_html": { - "type": "string", - "examples": [ - "

Do you like apples?

" - ] - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "type": "string", - "examples": [ - "0307116bbf7ced493b8d8a346c650b71" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-15T23:53:58Z" - ] - }, - "last_edited_at": { + ], "type": [ - "string", "null" - ], - "format": "date-time" - }, - "discussion_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" ] }, - "node_id": { - "type": "string", - "examples": [ - "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + "publisher": { + "readOnly": true, + "description": "The publisher of the advisory.", + "allOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ], + "type": [ + "null" ] }, - "number": { - "description": "The unique sequence number of a team discussion comment.", - "type": "integer", - "examples": [ - 42 + "identifiers": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of identifier.", + "enum": [ + "CVE", + "GHSA" + ] + }, + "value": { + "type": "string", + "description": "The identifier value." + } + }, + "required": [ + "type", + "value" + ] + }, + "readOnly": true + }, + "state": { + "type": "string", + "description": "The state of the advisory.", + "enum": [ + "published", + "closed", + "withdrawn", + "draft", + "triage" ] }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The date and time of when the advisory was created, in ISO 8601 format.", + "readOnly": true + }, "updated_at": { - "type": "string", + "type": [ + "string", + "null" + ], "format": "date-time", - "examples": [ - "2018-01-15T23:53:58Z" - ] + "description": "The date and time of when the advisory was last updated, in ISO 8601 format.", + "readOnly": true }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" - ] + "published_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The date and time of when the advisory was published, in ISO 8601 format.", + "readOnly": true }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The date and time of when the advisory was closed, in ISO 8601 format.", + "readOnly": true + }, + "withdrawn_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.", + "readOnly": true + }, + "submission": { + "type": [ + "object", + "null" + ], + "readOnly": true, "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" + "accepted": { + "type": "boolean", + "description": "Whether a private vulnerability report was accepted by the repository's administrators.", + "readOnly": true } }, "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "accepted" ] - } - }, - "required": [ - "author", - "body", - "body_html", - "body_version", - "created_at", - "last_edited_at", - "discussion_url", - "html_url", - "node_id", - "number", - "updated_at", - "url" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "author": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "body": "Do you like apples?", - "body_html": "

Do you like apples?

", - "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51", - "created_at": "2018-01-15T23:53:58Z", - "last_edited_at": null, - "discussion_url": "https://api.github.com/teams/2403582/discussions/1", - "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", - "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", - "number": 1, - "updated_at": "2018-01-15T23:53:58Z", - "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", - "reactions": { - "url": "https://api.github.com/teams/2403582/discussions/1/reactions", - "total_count": 5, - "+1": 3, - "-1": 1, - "laugh": 0, - "confused": 0, - "heart": 1, - "hooray": 0, - "eyes": 1, - "rocket": 1 - } - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "discussion-comments" - } - }, - "post": { - "summary": "Create a discussion comment", - "description": "Creates a new comment on a team discussion.\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)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "teams" - ], - "operationId": "teams/create-discussion-comment-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "body": { - "type": "string", - "description": "The discussion comment's body text." - } - }, - "required": [ - "body" - ] - }, - "examples": { - "default": { - "value": { - "body": "Do you like apples?" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Team Discussion Comment", - "description": "A reply to a discussion within a team.", - "type": "object", - "properties": { - "author": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", + }, + "vulnerabilities": { + "type": [ + "array", + "null" + ], + "items": { + "description": "A product affected by the vulnerability detailed in a repository security advisory.", "type": "object", "properties": { - "name": { + "package": { + "description": "The name of the package affected by the vulnerability.", "type": [ - "string", + "object", "null" + ], + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "enum": [ + "rubygems", + "npm", + "pip", + "maven", + "nuget", + "composer", + "go", + "rust", + "erlang", + "actions", + "pub", + "other", + "swift" + ] + }, + "name": { + "type": [ + "string", + "null" + ], + "description": "The unique package name within its ecosystem." + } + }, + "required": [ + "ecosystem", + "name" ] }, - "email": { + "vulnerable_version_range": { "type": [ "string", "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] + ], + "description": "The range of the package versions affected by the vulnerability." }, - "gravatar_id": { + "patched_versions": { "type": [ "string", "null" ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] + "description": "The package version(s) that resolve the vulnerability." }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] + "vulnerable_functions": { + "type": [ + "array", + "null" + ], + "description": "The functions in the package that are affected.", + "items": { + "type": "string" + } + } + }, + "required": [ + "package", + "vulnerable_version_range", + "patched_versions", + "vulnerable_functions" + ], + "additionalProperties": false + } + }, + "cvss": { + "type": [ + "object", + "null" + ], + "properties": { + "vector_string": { + "type": [ + "string", + "null" + ], + "description": "The CVSS vector." + }, + "score": { + "type": [ + "number", + "null" + ], + "description": "The CVSS score.", + "minimum": 0, + "maximum": 10, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + }, + "cvss_severities": { + "type": [ + "object", + "null" + ], + "properties": { + "cvss_v3": { + "type": [ + "object", + "null" + ], + "properties": { + "vector_string": { + "type": [ + "string", + "null" + ], + "description": "The CVSS 3 vector string." + }, + "score": { + "type": [ + "number", + "null" + ], + "description": "The CVSS 3 score.", + "minimum": 0, + "maximum": 10, + "readOnly": true + } }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] + "required": [ + "vector_string", + "score" + ] + }, + "cvss_v4": { + "type": [ + "object", + "null" + ], + "properties": { + "vector_string": { + "type": [ + "string", + "null" + ], + "description": "The CVSS 4 vector string." + }, + "score": { + "type": [ + "number", + "null" + ], + "description": "The CVSS 4 score.", + "minimum": 0, + "maximum": 10, + "readOnly": true + } }, - "subscriptions_url": { + "required": [ + "vector_string", + "score" + ] + } + } + }, + "cwes": { + "type": [ + "array", + "null" + ], + "items": { + "type": "object", + "properties": { + "cwe_id": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "description": "The Common Weakness Enumeration (CWE) identifier." }, - "organizations_url": { + "name": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { + "description": "The name of the CWE.", + "readOnly": true + } + }, + "required": [ + "cwe_id", + "name" + ] + }, + "readOnly": true + }, + "cwe_ids": { + "type": [ + "array", + "null" + ], + "description": "A list of only the CWE IDs.", + "items": { + "type": "string" + } + }, + "credits": { + "type": [ + "array", + "null" + ], + "items": { + "type": "object", + "properties": { + "login": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] + "description": "The username of the user credited." }, - "events_url": { + "type": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "description": "The type of credit the user is receiving.", + "enum": [ + "analyst", + "finder", + "reporter", + "coordinator", + "remediation_developer", + "remediation_reviewer", + "remediation_verifier", + "tool", + "sponsor", + "other" ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" + } + } + } + }, + "credits_detailed": { + "type": [ + "array", + "null" + ], + "items": { + "description": "A credit given to a user for a repository security advisory.", + "type": "object", + "properties": { + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, "type": { "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" + "description": "The type of credit the user is receiving.", + "enum": [ + "analyst", + "finder", + "reporter", + "coordinator", + "remediation_developer", + "remediation_reviewer", + "remediation_verifier", + "tool", + "sponsor", + "other" ] }, - "user_view_type": { + "state": { "type": "string", - "examples": [ - "public" + "description": "The state of the user's acceptance of the credit.", + "enum": [ + "accepted", + "declined", + "pending" ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", + "user", "type", - "url" - ] - } - ] - }, - "body": { - "description": "The main text of the comment.", - "type": "string", - "examples": [ - "I agree with this suggestion." - ] - }, - "body_html": { - "type": "string", - "examples": [ - "

Do you like apples?

" - ] - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "type": "string", - "examples": [ - "0307116bbf7ced493b8d8a346c650b71" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-15T23:53:58Z" - ] - }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "discussion_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion comment.", - "type": "integer", - "examples": [ - 42 - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-15T23:53:58Z" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" - ] - }, - "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" + "state" + ], + "additionalProperties": false }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - } - }, - "required": [ - "author", - "body", - "body_html", - "body_version", - "created_at", - "last_edited_at", - "discussion_url", - "html_url", - "node_id", - "number", - "updated_at", - "url" - ] - }, - "examples": { - "default": { - "value": { - "author": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false + "readOnly": true }, - "body": "Do you like apples?", - "body_html": "

Do you like apples?

", - "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51", - "created_at": "2018-01-15T23:53:58Z", - "last_edited_at": null, - "discussion_url": "https://api.github.com/teams/2403582/discussions/1", - "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", - "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", - "number": 1, - "updated_at": "2018-01-15T23:53:58Z", - "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", - "reactions": { - "url": "https://api.github.com/teams/2403582/discussions/1/reactions", - "total_count": 5, - "+1": 3, - "-1": 1, - "laugh": 0, - "confused": 0, - "heart": 1, - "hooray": 0, - "eyes": 1, - "rocket": 1 - } - } - } - } - } - } - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "discussion-comments" - } - } - }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": { - "get": { - "summary": "Get a discussion comment", - "description": "Get a specific comment on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", - "tags": [ - "teams" - ], - "operationId": "teams/get-discussion-comment-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Team Discussion Comment", - "description": "A reply to a discussion within a team.", - "type": "object", - "properties": { - "author": { - "anyOf": [ - { - "type": "null" - }, - { + "collaborating_users": { + "type": [ + "array", + "null" + ], + "description": "A list of users that collaborate on the advisory.", + "items": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -171092,1057 +164673,828 @@ "url" ] } - ] - }, - "body": { - "description": "The main text of the comment.", - "type": "string", - "examples": [ - "I agree with this suggestion." - ] - }, - "body_html": { - "type": "string", - "examples": [ - "

Do you like apples?

" - ] - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "type": "string", - "examples": [ - "0307116bbf7ced493b8d8a346c650b71" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-15T23:53:58Z" - ] - }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "discussion_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion comment.", - "type": "integer", - "examples": [ - 42 - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-15T23:53:58Z" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" - ] - }, - "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": [ - "author", - "body", - "body_html", - "body_version", - "created_at", - "last_edited_at", - "discussion_url", - "html_url", - "node_id", - "number", - "updated_at", - "url" - ] - }, - "examples": { - "default": { - "value": { - "author": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false }, - "body": "Do you like apples?", - "body_html": "

Do you like apples?

", - "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51", - "created_at": "2018-01-15T23:53:58Z", - "last_edited_at": null, - "discussion_url": "https://api.github.com/teams/2403582/discussions/1", - "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", - "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", - "number": 1, - "updated_at": "2018-01-15T23:53:58Z", - "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", - "reactions": { - "url": "https://api.github.com/teams/2403582/discussions/1/reactions", - "total_count": 5, - "+1": 3, - "-1": 1, - "laugh": 0, - "confused": 0, - "heart": 1, - "hooray": 0, - "eyes": 1, - "rocket": 1 - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "discussion-comments" - } - }, - "patch": { - "summary": "Update a discussion comment", - "description": "Edits the body text of a discussion comment.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "teams" - ], - "operationId": "teams/update-discussion-comment-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "body": { - "type": "string", - "description": "The discussion comment's body text." - } - }, - "required": [ - "body" - ] - }, - "examples": { - "default": { - "value": { - "body": "Do you like pineapples?" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Team Discussion Comment", - "description": "A reply to a discussion within a team.", - "type": "object", - "properties": { - "author": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", + "collaborating_teams": { + "type": [ + "array", + "null" + ], + "description": "A list of teams that collaborate on the advisory.", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] + "type": "integer" }, "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "type": "string" }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] + "name": { + "type": "string" }, - "gravatar_id": { + "slug": { + "type": "string" + }, + "description": { "type": [ "string", "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" ] }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] + "privacy": { + "type": "string" }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "notification_setting": { + "type": "string" }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] + "permission": { + "type": "string" }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" + "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" ] }, - "events_url": { + "url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "format": "uri" }, - "received_events_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" + "https://github.com/orgs/rails/teams/core" ] }, - "site_admin": { - "type": "boolean" + "members_url": { + "type": "string" }, - "starred_at": { + "repositories_url": { "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "format": "uri" }, - "user_view_type": { - "type": "string", - "examples": [ - "public" + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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", + "parent" ] } - ] - }, - "body": { - "description": "The main text of the comment.", - "type": "string", - "examples": [ - "I agree with this suggestion." - ] - }, - "body_html": { - "type": "string", - "examples": [ - "

Do you like apples?

" - ] - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "type": "string", - "examples": [ - "0307116bbf7ced493b8d8a346c650b71" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-15T23:53:58Z" - ] - }, - "last_edited_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "discussion_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" - ] - }, - "number": { - "description": "The unique sequence number of a team discussion comment.", - "type": "integer", - "examples": [ - 42 - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-01-15T23:53:58Z" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" - ] - }, - "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": [ - "author", - "body", - "body_html", - "body_version", - "created_at", - "last_edited_at", - "discussion_url", - "html_url", - "node_id", - "number", - "updated_at", - "url" - ] - }, - "examples": { - "default": { - "value": { - "author": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "body": "Do you like pineapples?", - "body_html": "

Do you like pineapples?

", - "body_version": "e6907b24d9c93cc0c5024a7af5888116", - "created_at": "2018-01-15T23:53:58Z", - "last_edited_at": "2018-01-26T18:22:20Z", - "discussion_url": "https://api.github.com/teams/2403582/discussions/1", - "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", - "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", - "number": 1, - "updated_at": "2018-01-26T18:22:20Z", - "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", - "reactions": { - "url": "https://api.github.com/teams/2403582/discussions/1/reactions", - "total_count": 5, - "+1": 3, - "-1": 1, - "laugh": 0, - "confused": 0, - "heart": 1, - "hooray": 0, - "eyes": 1, - "rocket": 1 - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "discussion-comments" - } - }, - "delete": { - "summary": "Delete a discussion comment", - "description": "Deletes a comment on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", - "tags": [ - "teams" - ], - "operationId": "teams/delete-discussion-comment-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "discussion-comments" - } - } - }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { - "get": { - "summary": "List reactions for a team discussion comment", - "description": "List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", - "tags": [ - "reactions" - ], - "operationId": "reactions/list-for-team-discussion-comment-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "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.", - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, + "private_fork": { + "readOnly": true, + "description": "A temporary private fork of the advisory's repository for collaborating on a fix.", + "allOf": [ { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Simple Repository", + "description": "A GitHub repository.", "type": "object", "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "A unique identifier of the repository.", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository.", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, "name": { - "type": [ - "string", - "null" + "type": "string", + "description": "The name of the repository.", + "examples": [ + "Hello-World" ] }, - "email": { + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository.", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com.", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { "type": [ "string", "null" + ], + "description": "The repository description.", + "examples": [ + "This your first repo!" ] }, - "login": { + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { "type": "string", + "description": "A template for the API URL to download the repository as an archive.", "examples": [ - "octocat" + "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, - "id": { - "type": "integer", - "format": "int64", + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository.", "examples": [ - 1 + "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, - "node_id": { + "blobs_url": { "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", "examples": [ - "MDQ6VXNlcjE=" + "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, - "avatar_url": { + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { "type": "string", "format": "uri", + "description": "A template for the API URL to list the contributors to the repository.", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "https://api.github.com/repos/octocat/Hello-World/contributors" ] }, - "gravatar_id": { - "type": [ - "string", - "null" - ], + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository.", "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "https://api.github.com/repos/octocat/Hello-World/deployments" ] }, - "url": { + "downloads_url": { "type": "string", "format": "uri", + "description": "The API URL to list the downloads on the repository.", "examples": [ - "https://api.github.com/users/octocat" + "https://api.github.com/repos/octocat/Hello-World/downloads" ] }, - "html_url": { + "events_url": { "type": "string", "format": "uri", + "description": "The API URL to list the events of the repository.", "examples": [ - "https://github.com/octocat" + "https://api.github.com/repos/octocat/Hello-World/events" ] }, - "followers_url": { + "forks_url": { "type": "string", "format": "uri", + "description": "The API URL to list the forks of the repository.", "examples": [ - "https://api.github.com/users/octocat/followers" + "https://api.github.com/repos/octocat/Hello-World/forks" ] }, - "following_url": { + "git_commits_url": { "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository.", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, - "gists_url": { + "git_refs_url": { "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository.", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, - "starred_url": { + "git_tags_url": { "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository.", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, - "subscriptions_url": { + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { "type": "string", "format": "uri", + "description": "The API URL to get information about the languages of the repository.", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "https://api.github.com/repos/octocat/Hello-World/languages" ] }, - "organizations_url": { + "merges_url": { "type": "string", "format": "uri", + "description": "The API URL to merge branches in the repository.", "examples": [ - "https://api.github.com/users/octocat/orgs" + "https://api.github.com/repos/octocat/Hello-World/merges" ] }, - "repos_url": { + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "stargazers_url": { "type": "string", "format": "uri", + "description": "The API URL to list the stargazers on the repository.", "examples": [ - "https://api.github.com/users/octocat/repos" + "https://api.github.com/repos/octocat/Hello-World/stargazers" ] }, - "events_url": { + "statuses_url": { "type": "string", + "description": "A template for the API URL to get information about statuses of a commit.", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, - "received_events_url": { + "subscribers_url": { "type": "string", "format": "uri", + "description": "The API URL to list the subscribers on the repository.", "examples": [ - "https://api.github.com/users/octocat/received_events" + "https://api.github.com/repos/octocat/Hello-World/subscribers" ] }, - "type": { + "subscription_url": { "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository.", "examples": [ - "User" + "https://api.github.com/repos/octocat/Hello-World/subscription" ] }, - "site_admin": { - "type": "boolean" + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tags" + ] }, - "starred_at": { + "teams_url": { "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository.", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "https://api.github.com/repos/octocat/Hello-World/teams" ] }, - "user_view_type": { + "trees_url": { "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", "examples": [ - "public" + "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository.", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks" ] } }, "required": [ - "avatar_url", + "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", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", + "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" ] } - ] - }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" ], - "examples": [ - "heart" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-05-20T20:09:31Z" + "type": [ + "null" ] } }, "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] + "ghsa_id", + "cve_id", + "url", + "html_url", + "summary", + "description", + "severity", + "author", + "publisher", + "identifiers", + "state", + "created_at", + "updated_at", + "published_at", + "closed_at", + "withdrawn_at", + "submission", + "vulnerabilities", + "cvss", + "cwes", + "cwe_ids", + "credits", + "credits_detailed", + "collaborating_users", + "collaborating_teams", + "private_fork" + ], + "additionalProperties": false } }, "examples": { "default": { "value": [ { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { + "ghsa_id": "GHSA-abcd-1234-efgh", + "cve_id": "CVE-2050-00000", + "url": "https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh", + "html_url": "https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh", + "summary": "A short summary of the advisory.", + "description": "A detailed description of what the advisory entails.", + "severity": "critical", + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -172162,19 +165514,512 @@ "type": "User", "site_admin": false }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" + "publisher": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-abcd-1234-efgh" + }, + { + "type": "CVE", + "value": "CVE-2050-00000" + } + ], + "state": "published", + "created_at": "2020-01-01T00:00:00Z", + "updated_at": "2020-01-02T00:00:00Z", + "published_at": "2020-01-03T00:00:00Z", + "closed_at": null, + "withdrawn_at": null, + "submission": null, + "vulnerabilities": [ + { + "package": { + "ecosystem": "pip", + "name": "a-package" + }, + "vulnerable_version_range": ">= 1.0.0, < 1.0.1", + "patched_versions": "1.0.1", + "vulnerable_functions": [ + "function1" + ] + }, + { + "package": { + "ecosystem": "pip", + "name": "another-package" + }, + "vulnerable_version_range": ">= 1.0.0, < 1.0.2", + "patched_versions": "1.0.2", + "vulnerable_functions": [ + "function2" + ] + } + ], + "cvss": { + "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", + "score": 9.8 + }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", + "score": 9.8 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 9.3 + } + }, + "cwes": [ + { + "cwe_id": "CWE-123", + "name": "A CWE" + } + ], + "cwe_ids": [ + "CWE-123" + ], + "credits": [ + { + "login": "octocat", + "type": "analyst" + } + ], + "credits_detailed": [ + { + "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 + }, + "type": "analyst", + "state": "accepted" + } + ], + "collaborating_users": [ + { + "login": "octokitten", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "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 + } + ], + "collaborating_teams": [ + { + "name": "Justice League", + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "permission": "admin", + "parent": null + } + ], + "private_fork": null + }, + { + "ghsa_id": "GHSA-1234-5678-9012", + "cve_id": "CVE-2051-0000", + "url": "https://api.github.com/repos/repo/a-package/security-advisories/GHSA-1234-5678-9012", + "html_url": "https://github.com/repo/a-package/security/advisories/GHSA-1234-5678-9012", + "summary": "A short summary of the advisory.", + "description": "A detailed description of what the advisory entails.", + "severity": "low", + "author": { + "login": "monauser", + "id": 2, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monauser", + "html_url": "https://github.com/monauser", + "followers_url": "https://api.github.com/users/monauser/followers", + "following_url": "https://api.github.com/users/monauser/following{/other_user}", + "gists_url": "https://api.github.com/users/monauser/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monauser/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monauser/subscriptions", + "organizations_url": "https://api.github.com/users/monauser/orgs", + "repos_url": "https://api.github.com/users/monauser/repos", + "events_url": "https://api.github.com/users/monauser/events{/privacy}", + "received_events_url": "https://api.github.com/users/monauser/received_events", + "type": "User", + "site_admin": false + }, + "publisher": { + "login": "monalisa", + "id": 3, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "site_admin": false + }, + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-1234-5678-9012" + }, + { + "type": "CVE", + "value": "CVE-2051-00000" + } + ], + "state": "published", + "created_at": "2020-01-03T00:00:00Z", + "updated_at": "2020-01-04T00:00:00Z", + "published_at": "2020-01-04T00:00:00Z", + "closed_at": null, + "withdrawn_at": null, + "submission": { + "accepted": true + }, + "vulnerabilities": [ + { + "package": { + "ecosystem": "pip", + "name": "a-package" + }, + "vulnerable_version_range": ">= 1.0.0, < 1.0.1", + "patched_versions": "1.0.1", + "vulnerable_functions": [ + "function1" + ] + }, + { + "package": { + "ecosystem": "pip", + "name": "another-package" + }, + "vulnerable_version_range": ">= 1.0.0, < 1.0.2", + "patched_versions": "1.0.2", + "vulnerable_functions": [ + "function2" + ] + } + ], + "cvss": { + "vector_string": "AV:P/AC:H/PR:H/UI:R/S:U/C:N/I:L/A:N", + "score": 1.6 + }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:P/AC:H/PR:H/UI:R/S:U/C:N/I:L/A:N", + "score": 1.6 + }, + "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": 7.1 + } + }, + "cwes": [ + { + "cwe_id": "CWE-456", + "name": "A CWE 2.0" + } + ], + "cwe_ids": [ + "CWE-456" + ], + "credits": [ + { + "login": "monauser", + "type": "reporter" + } + ], + "credits_detailed": [ + { + "user": { + "login": "monauser", + "id": 2, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monauser", + "html_url": "https://github.com/monauser", + "followers_url": "https://api.github.com/users/monauser/followers", + "following_url": "https://api.github.com/users/monauser/following{/other_user}", + "gists_url": "https://api.github.com/users/monauser/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monauser/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monauser/subscriptions", + "organizations_url": "https://api.github.com/users/monauser/orgs", + "repos_url": "https://api.github.com/users/monauser/repos", + "events_url": "https://api.github.com/users/monauser/events{/privacy}", + "received_events_url": "https://api.github.com/users/monauser/received_events", + "type": "User", + "site_admin": false + }, + "type": "reporter", + "state": "accepted" + } + ], + "collaborating_users": [ + { + "login": "octokitten", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "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 + } + ], + "collaborating_teams": [ + { + "name": "Justice League", + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "permission": "admin", + "parent": null + } + ], + "private_fork": { + "id": 217723378, + "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=", + "name": "octo-repo-ghsa-1234-5678-9012", + "full_name": "octo-org/octo-repo-ghsa-1234-5678-9012", + "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-ghsa-1234-5678-9012", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012", + "archive_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/comments{/number}", + "commits_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/commits{/sha}", + "compare_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/contributors", + "deployments_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/deployments", + "downloads_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/downloads", + "events_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/events", + "forks_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/forks", + "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/tags{/sha}", + "hooks_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/hooks", + "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/issues{/number}", + "keys_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/labels{/name}", + "languages_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/languages", + "merges_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/merges", + "milestones_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/pulls{/number}", + "releases_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/stargazers", + "statuses_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/subscribers", + "subscription_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/subscription", + "tags_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/tags", + "teams_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/teams", + "trees_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/trees{/sha}" + } } ] } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", + } + }, + "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "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" + } + } } } } @@ -172183,20 +166028,201 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" + "category": "security-advisories", + "subcategory": "repository-advisories" } - }, - "post": { - "summary": "Create reaction for a team discussion comment", - "description": "Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + } + }, + "/orgs/{org}/security-managers": { + "get": { + "summary": "List security manager teams", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the \"[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)\" endpoints instead.", "tags": [ - "reactions" + "orgs" ], - "operationId": "reactions/create-for-team-discussion-comment-in-org", + "operationId": "orgs/list-security-manager-teams", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment" + "url": "https://docs.github.com/rest/orgs/security-managers#list-security-manager-teams" + }, + "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", + "items": { + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + }, + "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 + } + ] + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "security-managers", + "deprecationDate": "2024-12-01", + "removalDate": "2026-01-01" + }, + "deprecated": true + } + }, + "/orgs/{org}/security-managers/teams/{team_slug}": { + "put": { + "summary": "Add a security manager team", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the \"[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)\" endpoints instead.", + "tags": [ + "orgs" + ], + "operationId": "orgs/add-security-manager-team", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/security-managers#add-a-security-manager-team" }, "parameters": [ { @@ -172216,581 +166242,270 @@ "schema": { "type": "string" } - }, + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "security-managers", + "deprecationDate": "2024-12-01", + "removalDate": "2026-01-01" + }, + "deprecated": true + }, + "delete": { + "summary": "Remove a security manager team", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the \"[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)\" endpoints instead.", + "tags": [ + "orgs" + ], + "operationId": "orgs/remove-security-manager-team", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/security-managers#remove-a-security-manager-team" + }, + "parameters": [ { - "name": "discussion_number", - "description": "The number that identifies the discussion.", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } }, { - "name": "comment_number", - "description": "The number that identifies the comment.", + "name": "team_slug", + "description": "The slug of the team name.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], - "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 team discussion comment.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - "required": [ - "content" - ] - }, - "examples": { - "default": { - "value": { - "content": "heart" - } - } - } - } + "responses": { + "204": { + "description": "Response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "security-managers", + "deprecationDate": "2024-12-01", + "removalDate": "2026-01-01" + }, + "deprecated": true + } + }, + "/orgs/{org}/settings/billing/actions": { + "get": { + "summary": "Get GitHub Actions billing for an organization", + "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 returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint.", + "operationId": "billing/get-github-actions-billing-org", + "tags": [ + "billing" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/billing/billing#get-github-actions-billing-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 when the reaction type has already been added to this team discussion comment", + "description": "Response", "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": { + "total_minutes_used": { "type": "integer", - "examples": [ - 1 - ] + "description": "The sum of the free and paid GitHub Actions minutes used." }, - "node_id": { - "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" - ] + "total_paid_minutes_used": { + "type": "integer", + "description": "The total paid GitHub Actions minutes used." }, - "user": { - "anyOf": [ - { - "type": "null" + "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." }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + "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." } - ] - }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "examples": [ - "heart" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-05-20T20:09:31Z" - ] + } } }, "required": [ - "id", - "node_id", - "user", - "content", - "created_at" + "total_minutes_used", + "total_paid_minutes_used", + "included_minutes", + "minutes_used_breakdown" ] }, "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" + "total_minutes_used": 305, + "total_paid_minutes_used": 0, + "included_minutes": 3000, + "minutes_used_breakdown": { + "UBUNTU": 205, + "MACOS": 10, + "WINDOWS": 90 + } } } } } } - }, - "201": { + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "billing", + "subcategory": "billing" + } + } + }, + "/orgs/{org}/settings/billing/packages": { + "get": { + "summary": "Get GitHub Packages billing for an organization", + "description": "Gets the free and paid storage used for GitHub Packages in gigabytes.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint.", + "operationId": "billing/get-github-packages-billing-org", + "tags": [ + "billing" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/billing/billing#get-github-packages-billing-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": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", "type": "object", "properties": { - "id": { + "total_gigabytes_bandwidth_used": { "type": "integer", - "examples": [ - 1 - ] + "description": "Sum of the free and paid storage space (GB) for GitHuub Packages." }, - "node_id": { - "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" - ] + "total_paid_gigabytes_bandwidth_used": { + "type": "integer", + "description": "Total paid storage space (GB) for GitHuub Packages." }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "examples": [ - "heart" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-05-20T20:09:31Z" - ] + "included_gigabytes_bandwidth": { + "type": "integer", + "description": "Free storage space (GB) for GitHub Packages." } }, "required": [ - "id", - "node_id", - "user", - "content", - "created_at" + "total_gigabytes_bandwidth_used", + "total_paid_gigabytes_bandwidth_used", + "included_gigabytes_bandwidth" ] }, "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" + "total_gigabytes_bandwidth_used": 50, + "total_paid_gigabytes_bandwidth_used": 40, + "included_gigabytes_bandwidth": 10 } } } @@ -172800,23 +166515,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" + "enabledForGitHubApps": false, + "category": "billing", + "subcategory": "billing" } } }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { - "delete": { - "summary": "Delete team discussion comment reaction", - "description": "> [!NOTE]\n> You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "/orgs/{org}/settings/billing/shared-storage": { + "get": { + "summary": "Get shared storage billing for an organization", + "description": "Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint.", + "operationId": "billing/get-shared-storage-billing-org", "tags": [ - "reactions" + "billing" ], - "operationId": "reactions/delete-for-team-discussion-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#delete-team-discussion-comment-reaction" + "url": "https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-an-organization" }, "parameters": [ { @@ -172827,68 +166542,67 @@ "schema": { "type": "string" } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "reaction_id", - "description": "The unique identifier of the reaction.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { - "204": { - "description": "Response" + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "days_left_in_billing_cycle": { + "type": "integer", + "description": "Numbers of days left in billing cycle." + }, + "estimated_paid_storage_for_month": { + "type": "integer", + "description": "Estimated storage space (GB) used in billing cycle." + }, + "estimated_storage_for_month": { + "type": "integer", + "description": "Estimated sum of free and paid storage space (GB) used in billing cycle." + } + }, + "required": [ + "days_left_in_billing_cycle", + "estimated_paid_storage_for_month", + "estimated_storage_for_month" + ] + }, + "examples": { + "default": { + "value": { + "days_left_in_billing_cycle": 20, + "estimated_paid_storage_for_month": 15, + "estimated_storage_for_month": 40 + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" + "enabledForGitHubApps": false, + "category": "billing", + "subcategory": "billing" } } }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { + "/orgs/{org}/settings/network-configurations": { "get": { - "summary": "List reactions for a team discussion", - "description": "List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "summary": "List hosted compute network configurations for an organization", + "description": "Lists all hosted compute network configurations configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint.", "tags": [ - "reactions" + "hosted-compute" ], - "operationId": "reactions/list-for-team-discussion-in-org", + "operationId": "hosted-compute/list-network-configurations-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion" + "url": "https://docs.github.com/rest/orgs/network-configurations#list-hosted-compute-network-configurations-for-an-organization" }, "parameters": [ { @@ -172900,43 +166614,6 @@ "type": "string" } }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "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.", - "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).\"", @@ -172962,263 +166639,103 @@ "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" + "type": "object", + "required": [ + "total_count", + "network_configurations" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "network_configurations": { + "type": "array", + "items": { + "title": "Hosted compute network configuration", + "description": "A hosted compute network configuration.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the network configuration.", + "type": "string", + "examples": [ + "123ABC456DEF789" + ] }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + "name": { + "description": "The name of the network configuration.", + "type": "string", + "examples": [ + "my-network-configuration" + ] + }, + "compute_service": { + "description": "The hosted compute service the network configuration supports.", + "type": "string", + "enum": [ + "none", + "actions", + "codespaces" + ] + }, + "network_settings_ids": { + "description": "The unique identifier of each network settings in the configuration.", + "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" + "examples": [ + "123ABC456DEF789" + ] + }, + "created_on": { + "description": "The time at which the network configuration was created, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2024-04-26T11:31:07Z" ] } - ] - }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "examples": [ - "heart" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-05-20T20:09:31Z" + }, + "required": [ + "id", + "name", + "created_on" ] } - }, - "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 + "value": { + "total_count": 2, + "network_configurations": [ + { + "id": "123456789ABCDEF", + "name": "My network configuration", + "compute_service": "actions", + "network_settings_ids": [ + "23456789ABDCEF1", + "3456789ABDCEF12" + ], + "created_on": "2022-10-09T23:39:01Z" }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" - } - ] + { + "id": "456789ABDCEF123", + "name": "My other configuration", + "compute_service": "none", + "network_settings_ids": [ + "56789ABDCEF1234", + "6789ABDCEF12345" + ], + "created_on": "2023-04-26T15:23:37Z" + } + ] + } } } } @@ -173236,20 +166753,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" + "category": "orgs", + "subcategory": "network-configurations" } }, "post": { - "summary": "Create reaction for a team discussion", - "description": "Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "summary": "Create a hosted compute network configuration for an organization", + "description": "Creates a hosted compute network configuration for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint.", "tags": [ - "reactions" + "hosted-compute" ], - "operationId": "reactions/create-for-team-discussion-in-org", + "operationId": "hosted-compute/create-network-configuration-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion" + "url": "https://docs.github.com/rest/orgs/network-configurations#create-a-hosted-compute-network-configuration-for-an-organization" }, "parameters": [ { @@ -173260,24 +166777,6 @@ "schema": { "type": "string" } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "requestBody": { @@ -173287,29 +166786,41 @@ "schema": { "type": "object", "properties": { - "content": { + "name": { + "description": "Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.", + "type": "string" + }, + "compute_service": { + "description": "The hosted compute service to use for the network configuration.", "type": "string", - "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion.", "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" + "none", + "actions" ] + }, + "network_settings_ids": { + "type": "array", + "minItems": 1, + "maxItems": 1, + "description": "The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified.", + "items": { + "type": "string" + } } }, "required": [ - "content" + "name", + "network_settings_ids" ] }, "examples": { "default": { "value": { - "content": "heart" + "name": "my-network-configuration", + "network_settings_ids": [ + "23456789ABDCEF1" + ], + "compute_service": "actions" } } } @@ -173317,550 +166828,228 @@ } }, "responses": { - "200": { + "201": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "title": "Hosted compute network configuration", + "description": "A hosted compute network configuration.", "type": "object", "properties": { "id": { - "type": "integer", + "description": "The unique identifier of the network configuration.", + "type": "string", "examples": [ - 1 + "123ABC456DEF789" ] }, - "node_id": { + "name": { + "description": "The name of the network configuration.", "type": "string", "examples": [ - "MDg6UmVhY3Rpb24x" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "my-network-configuration" ] }, - "content": { - "description": "The reaction to use", + "compute_service": { + "description": "The hosted compute service the network configuration supports.", "type": "string", "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], + "none", + "actions", + "codespaces" + ] + }, + "network_settings_ids": { + "description": "The unique identifier of each network settings in the configuration.", + "type": "array", + "items": { + "type": "string" + }, "examples": [ - "heart" + "123ABC456DEF789" ] }, - "created_at": { - "type": "string", + "created_on": { + "description": "The time at which the network configuration was created, in ISO 8601 format.", + "type": [ + "string", + "null" + ], "format": "date-time", "examples": [ - "2016-05-20T20:09:31Z" + "2024-04-26T11:31:07Z" ] } }, "required": [ "id", - "node_id", - "user", - "content", - "created_at" + "name", + "created_on" ] }, "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" + "id": "123456789ABCDEF", + "name": "My network configuration", + "compute_service": "actions", + "network_settings_ids": [ + "23456789ABDCEF1", + "3456789ABDCEF12" + ], + "created_on": "2022-10-09T23:39:01Z" } } } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "network-configurations" + } + } + }, + "/orgs/{org}/settings/network-configurations/{network_configuration_id}": { + "get": { + "summary": "Get a hosted compute network configuration for an organization", + "description": "Gets a hosted compute network configuration configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint.", + "tags": [ + "hosted-compute" + ], + "operationId": "hosted-compute/get-network-configuration-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "201": { + { + "name": "network_configuration_id", + "description": "Unique identifier of the hosted compute network configuration.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "title": "Hosted compute network configuration", + "description": "A hosted compute network configuration.", "type": "object", "properties": { "id": { - "type": "integer", + "description": "The unique identifier of the network configuration.", + "type": "string", "examples": [ - 1 + "123ABC456DEF789" ] }, - "node_id": { + "name": { + "description": "The name of the network configuration.", "type": "string", "examples": [ - "MDg6UmVhY3Rpb24x" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "my-network-configuration" ] }, - "content": { - "description": "The reaction to use", + "compute_service": { + "description": "The hosted compute service the network configuration supports.", "type": "string", "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], + "none", + "actions", + "codespaces" + ] + }, + "network_settings_ids": { + "description": "The unique identifier of each network settings in the configuration.", + "type": "array", + "items": { + "type": "string" + }, "examples": [ - "heart" + "123ABC456DEF789" ] }, - "created_at": { - "type": "string", + "created_on": { + "description": "The time at which the network configuration was created, in ISO 8601 format.", + "type": [ + "string", + "null" + ], "format": "date-time", "examples": [ - "2016-05-20T20:09:31Z" + "2024-04-26T11:31:07Z" ] } }, "required": [ "id", - "node_id", - "user", - "content", - "created_at" + "name", + "created_on" ] }, "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" + "id": "123456789ABCDEF", + "name": "My network configuration", + "compute_service": "actions", + "network_settings_ids": [ + "23456789ABDCEF1", + "3456789ABDCEF12" + ], + "created_on": "2022-10-09T23:39:01Z" } } } } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } } } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "reactions", - "subcategory": "reactions" + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "network-configurations" } - } - }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { - "delete": { - "summary": "Delete team discussion reaction", - "description": "> [!NOTE]\n> You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + }, + "patch": { + "summary": "Update a hosted compute network configuration for an organization", + "description": "Updates a hosted compute network configuration for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint.", "tags": [ - "reactions" + "hosted-compute" ], - "operationId": "reactions/delete-for-team-discussion", + "operationId": "hosted-compute/update-network-configuration-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#delete-team-discussion-reaction" + "url": "https://docs.github.com/rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization" }, "parameters": [ { @@ -173873,30 +167062,173 @@ } }, { - "name": "team_slug", - "description": "The slug of the team name.", + "name": "network_configuration_id", + "description": "Unique identifier of the hosted compute network configuration.", "in": "path", "required": true, "schema": { "type": "string" } - }, + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.", + "type": "string" + }, + "compute_service": { + "description": "The hosted compute service to use for the network configuration.", + "type": "string", + "enum": [ + "none", + "actions" + ] + }, + "network_settings_ids": { + "type": "array", + "minItems": 0, + "maxItems": 1, + "description": "The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified.", + "items": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": { + "name": "my-network-configuration", + "network_settings_ids": [ + "23456789ABDCEF1" + ], + "compute_service": "actions" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Hosted compute network configuration", + "description": "A hosted compute network configuration.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the network configuration.", + "type": "string", + "examples": [ + "123ABC456DEF789" + ] + }, + "name": { + "description": "The name of the network configuration.", + "type": "string", + "examples": [ + "my-network-configuration" + ] + }, + "compute_service": { + "description": "The hosted compute service the network configuration supports.", + "type": "string", + "enum": [ + "none", + "actions", + "codespaces" + ] + }, + "network_settings_ids": { + "description": "The unique identifier of each network settings in the configuration.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "123ABC456DEF789" + ] + }, + "created_on": { + "description": "The time at which the network configuration was created, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2024-04-26T11:31:07Z" + ] + } + }, + "required": [ + "id", + "name", + "created_on" + ] + }, + "examples": { + "default": { + "value": { + "id": "123456789ABCDEF", + "name": "My network configuration", + "compute_service": "actions", + "network_settings_ids": [ + "23456789ABDCEF1", + "3456789ABDCEF12" + ], + "created_on": "2022-10-09T23:39:01Z" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "network-configurations" + } + }, + "delete": { + "summary": "Delete a hosted compute network configuration from an organization", + "description": "Deletes a hosted compute network configuration from an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint.", + "tags": [ + "hosted-compute" + ], + "operationId": "hosted-compute/delete-network-configuration-from-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization" + }, + "parameters": [ { - "name": "discussion_number", - "description": "The number that identifies the discussion.", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } }, { - "name": "reaction_id", - "description": "The unique identifier of the reaction.", + "name": "network_configuration_id", + "description": "Unique identifier of the hosted compute network configuration.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], @@ -173908,22 +167240,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" + "category": "orgs", + "subcategory": "network-configurations" } } }, - "/orgs/{org}/teams/{team_slug}/invitations": { + "/orgs/{org}/settings/network-settings/{network_settings_id}": { "get": { - "summary": "List pending team invitations", - "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`.", + "summary": "Get a hosted compute network settings resource for an organization", + "description": "Gets a hosted compute network settings resource configured for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint.", "tags": [ - "teams" + "hosted-compute" ], - "operationId": "teams/list-pending-invitations-in-org", + "operationId": "hosted-compute/get-network-settings-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/members#list-pending-team-invitations" + "url": "https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization" }, "parameters": [ { @@ -173936,31 +167268,13 @@ } }, { - "name": "team_slug", - "description": "The slug of the team name.", + "name": "network_settings_id", + "description": "Unique identifier of the hosted compute network settings.", "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": { @@ -173969,286 +167283,62 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Organization Invitation", - "description": "Organization Invitation", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "role": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "failed_at": { - "type": [ - "string", - "null" - ] - }, - "failed_reason": { - "type": [ - "string", - "null" - ] - }, - "inviter": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "team_count": { - "type": "integer" - }, - "node_id": { - "type": "string", - "examples": [ - "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" - ] - }, - "invitation_teams_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/organizations/16/invitations/1/teams\"" - ] - }, - "invitation_source": { - "type": "string", - "examples": [ - "\"member\"" - ] - } + "title": "Hosted compute network settings resource", + "description": "A hosted compute network settings resource.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the network settings resource.", + "type": "string", + "examples": [ + "220F78DACB92BBFBC5E6F22DE1CCF52309D" + ] }, - "required": [ - "id", - "login", - "email", - "role", - "created_at", - "inviter", - "team_count", - "invitation_teams_url", - "node_id" - ] - } + "network_configuration_id": { + "description": "The identifier of the network configuration that is using this settings resource.", + "type": "string", + "examples": [ + "934E208B3EE0BD60CF5F752C426BFB53562" + ] + }, + "name": { + "description": "The name of the network settings resource.", + "type": "string", + "examples": [ + "my-network-settings" + ] + }, + "subnet_id": { + "description": "The subnet this network settings resource is configured for.", + "type": "string", + "examples": [ + "/subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet" + ] + }, + "region": { + "description": "The location of the subnet this network settings resource is configured for.", + "type": "string", + "examples": [ + "eastus" + ] + } + }, + "required": [ + "id", + "name", + "subnet_id", + "region" + ] }, "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", - "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 - }, - "team_count": 2, - "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams", - "invitation_source": "member" - } - ] + "value": { + "id": "220F78DACB92BBFBC5E6F22DE1CCF52309D", + "network_configuration_id": "934E208B3EE0BD60CF5F752C426BFB53562", + "name": "my_network_settings", + "subnet_id": "/subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet", + "region": "eastus" + } } } } @@ -174266,22 +167356,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "members" + "category": "orgs", + "subcategory": "network-configurations" } } }, - "/orgs/{org}/teams/{team_slug}/members": { + "/orgs/{org}/team/{team_slug}/copilot/metrics": { "get": { - "summary": "List team members", - "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.", + "summary": "Get Copilot metrics for a team", + "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 team had **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 containing the team within GitHub settings.\nOnly organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team.\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": [ - "teams" + "copilot" ], - "operationId": "teams/list-members-in-org", + "operationId": "copilot/copilot-metrics-for-team", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/members#list-team-members" + "url": "https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team" }, "parameters": [ { @@ -174303,27 +167393,21 @@ } }, { - "name": "role", - "description": "Filters members returned by their role in the team.", + "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", - "enum": [ - "member", - "maintainer", - "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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "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": "integer", - "default": 30 + "type": "string" } }, { @@ -174334,6 +167418,15 @@ "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": { @@ -174344,309 +167437,528 @@ "schema": { "type": "array", "items": { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { + "date": { "type": "string", - "examples": [ - "octocat" - ] + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." }, - "id": { + "total_active_users": { "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "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." }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] + "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." }, - "gravatar_id": { + "copilot_ide_code_completions": { "type": [ - "string", + "object", "null" ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "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", + "null" + ], + "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." + } + } + } + } + } + } + } + } + } + } + } }, - "site_admin": { - "type": "boolean" + "copilot_ide_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in the IDE.", + "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", + "null" + ], + "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." + } + } + } + } + } + } + } + } }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "copilot_dotcom_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in GitHub.com", + "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", + "null" + ], + "description": "The training date for the custom model (if applicable)." + }, + "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." + } + } + } + } + } }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] + "copilot_dotcom_pull_requests": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot for pull requests.", + "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", + "null" + ], + "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": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + "date" + ], + "additionalProperties": true } }, "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 + "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 + } + ] + } + ] + } } ] } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { "schema": { - "type": "string" + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "members" - } - } - }, - "/orgs/{org}/teams/{team_slug}/memberships/{username}": { - "get": { - "summary": "Get team membership for a user", - "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team).", - "tags": [ - "teams" - ], - "operationId": "teams/get-membership-for-user-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/members#get-team-membership-for-a-user" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "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": { - "200": { - "description": "Response", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "title": "Team Membership", - "description": "Team Membership", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri" + "message": { + "type": "string" }, - "role": { - "description": "The role of the user in the team.", - "enum": [ - "member", - "maintainer" - ], - "default": "member", - "type": "string", - "examples": [ - "member" - ] + "documentation_url": { + "type": "string" }, - "state": { - "description": "The state of the user's membership in the team.", - "type": "string", - "enum": [ - "active", - "pending" - ] - } - }, - "required": [ - "role", - "state", - "url" - ] - }, - "examples": { - "response-if-user-is-a-team-maintainer": { - "summary": "Response if user is a team maintainer", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "maintainer", - "state": "active" + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } @@ -174654,220 +167966,77 @@ } }, "404": { - "description": "if user has no team membership" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "members" - } - }, - "put": { - "summary": "Add or update team membership for a user", - "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", - "tags": [ - "teams" - ], - "operationId": "teams/add-or-update-membership-for-user-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "role": { - "type": "string", - "description": "The role that this user should have in the team.", - "enum": [ - "member", - "maintainer" - ], - "default": "member" - } - } - }, - "examples": { - "default": { - "summary": "Add or update team membership for an organization member", - "value": { - "role": "maintainer" + "description": "Resource not found", + "content": { + "application/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": { - "200": { - "description": "Response", + }, + "422": { + "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.", "content": { "application/json": { "schema": { - "title": "Team Membership", - "description": "Team Membership", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri" + "message": { + "type": "string" }, - "role": { - "description": "The role of the user in the team.", - "enum": [ - "member", - "maintainer" - ], - "default": "member", - "type": "string", - "examples": [ - "member" - ] + "documentation_url": { + "type": "string" }, - "state": { - "description": "The state of the user's membership in the team.", - "type": "string", - "enum": [ - "active", - "pending" - ] - } - }, - "required": [ - "role", - "state", - "url" - ] - }, - "examples": { - "response-if-users-membership-with-team-is-now-pending": { - "summary": "Response if user's membership with team is now pending", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "pending" + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } - }, - "403": { - "description": "Forbidden if team synchronization is set up" - }, - "422": { - "description": "Unprocessable Entity if you attempt to add an organization to a team" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "members" - } - }, - "delete": { - "summary": "Remove team membership for a user", - "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", - "tags": [ - "teams" - ], - "operationId": "teams/remove-membership-for-user-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "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 if team synchronization is set up" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "members" + "category": "copilot", + "subcategory": "copilot-metrics" } } }, - "/orgs/{org}/teams/{team_slug}/projects": { + "/orgs/{org}/teams": { "get": { - "summary": "List team projects", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "summary": "List teams", + "description": "Lists all teams in an organization that are visible to the authenticated user.", "tags": [ "teams" ], - "operationId": "teams/list-projects-in-org", + "operationId": "teams/list", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#list-team-projects" + "url": "https://docs.github.com/rest/teams/teams#list-teams" }, "parameters": [ { @@ -174879,15 +168048,6 @@ "type": "string" } }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "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).\"", @@ -174915,22 +168075,10 @@ "schema": { "type": "array", "items": { - "title": "Team Project", - "description": "A team's access to a project.", + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, "id": { "type": "integer" }, @@ -174940,235 +168088,200 @@ "name": { "type": "string" }, - "body": { + "slug": { + "type": "string" + }, + "description": { "type": [ "string", "null" ] }, - "number": { - "type": "integer" + "privacy": { + "type": "string" }, - "state": { + "notification_setting": { "type": "string" }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", + "permission": { + "type": "string" + }, + "permissions": { "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] + "pull": { + "type": "boolean" }, - "type": { - "type": "string", - "examples": [ - "User" - ] + "triage": { + "type": "boolean" }, - "site_admin": { + "push": { "type": "boolean" }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "maintain": { + "type": "boolean" }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] + "admin": { + "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" + "pull", + "triage", + "push", + "maintain", + "admin" ] }, - "created_at": { - "type": "string" + "url": { + "type": "string", + "format": "uri" }, - "updated_at": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", + "members_url": { "type": "string" }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", - "type": "boolean" + "repositories_url": { + "type": "string", + "format": "uri" }, - "permissions": { - "type": "object", - "properties": { - "read": { - "type": "boolean" - }, - "write": { - "type": "boolean" + "parent": { + "anyOf": [ + { + "type": "null" }, - "admin": { - "type": "boolean" + { + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] } - }, - "required": [ - "read", - "write", - "admin" ] } }, "required": [ - "owner_url", - "url", - "html_url", - "columns_url", "id", "node_id", + "url", + "members_url", "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" ] } }, @@ -175176,45 +168289,19 @@ "default": { "value": [ { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "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 - }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false - } + "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 } ] } @@ -175229,30 +168316,51 @@ } } } + }, + "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": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { - "get": { - "summary": "Check team permissions for a project", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "subcategory": "teams" + } + }, + "post": { + "summary": "Create a team", + "description": "To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://docs.github.com/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/about-teams)\".", "tags": [ "teams" ], - "operationId": "teams/check-permissions-for-project-in-org", + "operationId": "teams/create", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project" + "url": "https://docs.github.com/rest/teams/teams#create-a-team" }, "parameters": [ { @@ -175263,95 +168371,344 @@ "schema": { "type": "string" } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the team." + }, + "description": { + "type": "string", + "description": "The description of the team." + }, + "maintainers": { + "type": "array", + "description": "List GitHub usernames for organization members who will become team maintainers.", + "items": { + "type": "string" + } + }, + "repo_names": { + "type": "array", + "description": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.", + "items": { + "type": "string" + } + }, + "privacy": { + "type": "string", + "description": "The level of privacy this team should have. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \nDefault: `secret` \n**For a parent or child team:** \n * `closed` - visible to all members of this organization. \nDefault for child team: `closed`", + "enum": [ + "secret", + "closed" + ] + }, + "notification_setting": { + "type": "string", + "description": "The notification setting the team has chosen. The options are: \n * `notifications_enabled` - team members receive notifications when the team is @mentioned. \n * `notifications_disabled` - no one receives notifications. \nDefault: `notifications_enabled`", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, + "permission": { + "type": "string", + "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.", + "enum": [ + "pull", + "push" + ], + "default": "pull" + }, + "parent_team_id": { + "type": "integer", + "description": "The ID of a team to set as the parent team." + } + }, + "required": [ + "name" + ] + }, + "examples": { + "default": { + "value": { + "name": "Justice League", + "description": "A great team", + "permission": "push", + "notification_setting": "notifications_enabled", + "privacy": "closed" + } + } + } + } + } + }, "responses": { - "200": { + "201": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Team Project", - "description": "A team's access to a project.", + "title": "Full Team", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "owner_url": { - "type": "string" + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] }, "url": { - "type": "string" + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] }, "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] }, "name": { - "type": "string" + "description": "Name of the team", + "type": "string", + "examples": [ + "Developers" + ] }, - "body": { + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "description": { "type": [ "string", "null" + ], + "examples": [ + "A great team." ] }, - "number": { - "type": "integer" + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": [ + "closed", + "secret" + ], + "examples": [ + "closed" + ] }, - "state": { - "type": "string" + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "examples": [ + "notifications_enabled" + ] }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "push" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "parent": { + "anyOf": [ + { + "type": "null" }, - "email": { - "type": [ - "string", - "null" + { + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" ] - }, + } + ] + }, + "members_count": { + "type": "integer", + "examples": [ + 3 + ] + }, + "repos_count": { + "type": "integer", + "examples": [ + 10 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-14T16:53:42Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-08-17T12:37:15Z" + ] + }, + "organization": { + "title": "Team Organization", + "description": "Team Organization", + "type": "object", + "properties": { "login": { "type": "string", "examples": [ - "octocat" + "github" ] }, "id": { "type": "integer", - "format": "int64", "examples": [ 1 ] @@ -175359,233 +168716,440 @@ "node_id": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "MDEyOk9yZ2FuaXphdGlvbjE=" ] }, - "avatar_url": { + "url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "https://api.github.com/orgs/github" ] }, - "gravatar_id": { - "type": [ - "string", - "null" - ], + "repos_url": { + "type": "string", + "format": "uri", "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "https://api.github.com/orgs/github/repos" ] }, - "url": { + "events_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "https://api.github.com/orgs/github/events" ] }, - "html_url": { + "hooks_url": { "type": "string", - "format": "uri", "examples": [ - "https://github.com/octocat" + "https://api.github.com/orgs/github/hooks" ] }, - "followers_url": { + "issues_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "https://api.github.com/orgs/github/issues" ] }, - "following_url": { + "members_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "https://api.github.com/orgs/github/members{/member}" ] }, - "gists_url": { + "public_members_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "https://api.github.com/orgs/github/public_members{/member}" ] }, - "starred_url": { + "avatar_url": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "https://github.com/images/error/octocat_happy.gif" ] }, - "subscriptions_url": { + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + }, + "name": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "github" ] }, - "organizations_url": { + "company": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "GitHub" ] }, - "repos_url": { + "blog": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "https://github.com/blog" ] }, - "events_url": { + "location": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "San Francisco" ] }, - "received_events_url": { + "email": { + "type": "string", + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "github" + ] + }, + "is_verified": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_organization_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_repository_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "https://github.com/octocat" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" ] }, "type": { "type": "string", "examples": [ - "User" + "Organization" ] }, - "site_admin": { - "type": "boolean" + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] }, - "starred_at": { - "type": "string", + "owned_private_repos": { + "type": "integer", "examples": [ - "\"2020-07-09T00:17:55Z\"" + 100 ] }, - "user_view_type": { + "private_gists": { + "type": [ + "integer", + "null" + ], + "examples": [ + 81 + ] + }, + "disk_usage": { + "type": [ + "integer", + "null" + ], + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": [ + "integer", + "null" + ], + "examples": [ + 8 + ] + }, + "billing_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "org@example.com" + ] + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": [ + "string", + "null" + ] + }, + "members_can_create_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "two_factor_requirement_enabled": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "members_allowed_repository_creation_type": { "type": "string", "examples": [ - "public" + "all" + ] + }, + "members_can_create_public_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_public_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_fork_private_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", + "login", + "url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", "repos_url", - "site_admin", - "starred_url", - "subscriptions_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", - "url" + "created_at", + "updated_at", + "archived_at" ] }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", - "type": "string" - }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", - "type": "boolean" - }, - "permissions": { - "type": "object", - "properties": { - "read": { - "type": "boolean" - }, - "write": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "read", - "write", - "admin" + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ - "owner_url", - "url", - "html_url", - "columns_url", "id", "node_id", + "url", + "members_url", "name", - "body", - "number", - "state", - "creator", + "description", + "permission", + "html_url", + "repositories_url", + "slug", "created_at", "updated_at", - "permissions" + "members_count", + "repos_count", + "organization" ] }, "examples": { "default": { "value": { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "creator": { - "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, + "members_count": 3, + "repos_count": 10, + "created_at": "2017-07-14T16:53:42Z", + "updated_at": "2017-08-17T12:37:15Z", + "organization": { + "login": "github", "id": 1, - "node_id": "MDQ6VXNlcjE=", + "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", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "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", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "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-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" } } } @@ -175593,1232 +169157,103 @@ } } }, - "404": { - "description": "Not Found if project is not managed by this team" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "put": { - "summary": "Add or update team project permissions", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/add-or-update-project-permissions-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": [ - "object", - "null" - ], - "properties": { - "permission": { - "type": "string", - "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", - "enum": [ - "read", - "write", - "admin" - ] - } - } - }, - "examples": { - "default": { - "summary": "Updates the permissions for the team to write for the project", - "value": { - "permission": "write" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden if the project is not owned by the 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" - } - } - }, - "examples": { - "response-if-the-project-is-not-owned-by-the-organization": { - "value": { - "message": "Must have admin rights to Repository.", - "documentation_url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Remove a project from a team", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/remove-project-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/orgs/{org}/teams/{team_slug}/repos": { - "get": { - "summary": "List team repositories", - "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", - "tags": [ - "teams" - ], - "operationId": "teams/list-repos-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#list-team-repositories" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "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": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "examples": [ - "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", + }, + "errors": { + "type": "array", + "items": { "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# 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", - "null" - ], - "format": "uri" - } - }, "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" + "code" ], "properties": { - "key": { - "type": "string" - }, - "name": { + "resource": { "type": "string" }, - "spdx_id": { + "field": { "type": "string" }, - "url": { + "message": { "type": "string" }, - "node_id": { + "code": { "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "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" - ] - } - } + "index": { + "type": "integer" }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" + }, + { + "type": [ + "integer", + "null" ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "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": [ - "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": 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": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "has_discussions": false, - "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 - }, - "security_and_analysis": { - "advanced_security": { - "status": "enabled" - }, - "secret_scanning": { - "status": "enabled" - }, - "secret_scanning_push_protection": { - "status": "disabled" - }, - "secret_scanning_non_provider_patterns": { - "status": "disabled" + ] } } } - ] + } } } } - }, - "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" + } + } } } } @@ -176832,17 +169267,17 @@ } } }, - "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": { + "/orgs/{org}/teams/{team_slug}": { "get": { - "summary": "Check team permissions for a repository", - "description": "Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header.\n\nIf a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.\n\nIf the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", + "summary": "Get a team by name", + "description": "Gets a team using the team's `slug`. To create the `slug`, GitHub replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `\"My TEam Näme\"` would become `my-team-name`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`.", "tags": [ "teams" ], - "operationId": "teams/check-permissions-for-repo-in-org", + "operationId": "teams/get-by-name", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository" + "url": "https://docs.github.com/rest/teams/teams#get-a-team-by-name" }, "parameters": [ { @@ -176862,38 +169297,20 @@ "schema": { "type": "string" } - }, - { - "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": "Alternative response with repository permissions", + "description": "Response", "content": { "application/json": { "schema": { - "title": "Team Repository", - "description": "A team's access to a repository.", + "title": "Full Team", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { - "description": "Unique identifier of the repository", + "description": "Unique identifier of the team", "type": "integer", "examples": [ 42 @@ -176902,149 +169319,101 @@ "node_id": { "type": "string", "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" ] }, "name": { - "description": "The name of the repository.", + "description": "Name of the team", "type": "string", "examples": [ - "Team Environment" + "Developers" ] }, - "full_name": { + "slug": { "type": "string", "examples": [ - "octocat/Hello-World" + "justice-league" ] }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." ] }, - "forks": { - "type": "integer" + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": [ + "closed", + "secret" + ], + "examples": [ + "closed" + ] }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "examples": [ + "notifications_enabled" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ "push" ] }, - "role_name": { + "members_url": { "type": "string", "examples": [ - "admin" + "https://api.github.com/organizations/1/team/1/members{/member}" ] }, - "owner": { + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "parent": { "anyOf": [ { "type": "null" }, { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { + "description": "Unique identifier of the team", "type": "integer", - "format": "int64", "examples": [ 1 ] @@ -177052,959 +169421,618 @@ "node_id": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "MDQ6VGVhbTE=" ] }, "url": { + "description": "URL for the team", "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" + "https://api.github.com/organizations/1/team/1" ] }, - "followers_url": { + "members_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "https://api.github.com/organizations/1/team/1/members{/member}" ] }, - "following_url": { + "name": { + "description": "Name of the team", "type": "string", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "Justice League" ] }, - "gists_url": { - "type": "string", + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "A great team." ] }, - "starred_url": { + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "admin" ] }, - "subscriptions_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "closed" ] }, - "organizations_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "notifications_enabled" ] }, - "repos_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "https://github.com/orgs/rails/teams/core" ] }, - "received_events_url": { + "repositories_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" + "https://api.github.com/organizations/1/team/1/repos" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { + "slug": { "type": "string", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "justice-league" ] }, - "user_view_type": { + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ - "public" + "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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" ] } ] }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", + "members_count": { + "type": "integer", "examples": [ - "https://github.com/octocat/Hello-World.git" + 3 ] }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", + "repos_count": { + "type": "integer", "examples": [ - "git:git.example.com/octocat/Hello-World" + 10 ] }, - "hooks_url": { + "created_at": { "type": "string", - "format": "uri", + "format": "date-time", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" + "2017-07-14T16:53:42Z" ] }, - "svn_url": { + "updated_at": { "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", + "format": "date-time", "examples": [ - 80 + "2017-08-17T12:37:15Z" ] }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "type": "integer", - "examples": [ - 108 + "organization": { + "title": "Team Organization", + "description": "Team Organization", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + }, + "name": { + "type": "string", + "examples": [ + "github" + ] + }, + "company": { + "type": "string", + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": "string", + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": "string", + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "github" + ] + }, + "is_verified": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_organization_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_repository_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "private_gists": { + "type": [ + "integer", + "null" + ], + "examples": [ + 81 + ] + }, + "disk_usage": { + "type": [ + "integer", + "null" + ], + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": [ + "integer", + "null" + ], + "examples": [ + 8 + ] + }, + "billing_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "org@example.com" + ] + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": [ + "string", + "null" + ] + }, + "members_can_create_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "two_factor_requirement_enabled": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "members_allowed_repository_creation_type": { + "type": "string", + "examples": [ + "all" + ] + }, + "members_can_create_public_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_public_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_fork_private_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "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" ] }, - "default_branch": { - "description": "The default branch of the repository.", + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean", - "examples": [ - false + "uid=example,ou=users,dc=github,dc=com" ] - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "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", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", "created_at", - "updated_at" + "updated_at", + "members_count", + "repos_count", + "organization" ] }, "examples": { - "alternative-response-with-repository-permissions": { + "default": { "value": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "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, + "members_count": 3, + "repos_count": 10, + "created_at": "2017-07-14T16:53:42Z", + "updated_at": "2017-08-17T12:37:15Z", + "organization": { + "login": "github", "id": 1, - "node_id": "MDQ6VXNlcjE=", + "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", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "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", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "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": false, - "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, - "maintain": false, - "push": false, - "triage": false, - "pull": true - }, - "role_name": "read", - "allow_rebase_merge": true, - "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://api.github.com/licenses/mit" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + } } } } } } }, - "204": { - "description": "Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header." - }, "404": { - "description": "Not Found if team does not have permission for the repository" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams" - } - }, - "put": { - "summary": "Add or update team repository permissions", - "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", - "tags": [ - "teams" - ], - "operationId": "teams/add-or-update-repo-permissions-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "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": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "permission": { - "type": "string", - "description": "The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository." - } - } - }, - "examples": { - "default": { - "summary": "Adding a team to an organization repository with the write role", - "value": { - "permission": "push" + "description": "Resource not found", + "content": { + "application/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, @@ -178012,79 +170040,16 @@ "subcategory": "teams" } }, - "delete": { - "summary": "Remove a repository from a team", - "description": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", - "tags": [ - "teams" - ], - "operationId": "teams/remove-repo-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "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" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams" - } - } - }, - "/orgs/{org}/teams/{team_slug}/teams": { - "get": { - "summary": "List child teams", - "description": "Lists the child teams of the team specified by `{team_slug}`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`.", + "patch": { + "summary": "Update a team", + "description": "To edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`.", "tags": [ "teams" ], - "operationId": "teams/list-child-in-org", + "operationId": "teams/update-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#list-child-teams" + "url": "https://docs.github.com/rest/teams/teams#update-a-team" }, "parameters": [ { @@ -178104,350 +170069,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": { - "200": { - "description": "if child teams exist", - "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", - "null" - ] - }, - "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", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] - } - }, - "examples": { - "response-if-child-teams-exist": { - "value": [ - { - "id": 2, - "node_id": "MDQ6VGVhbTI=", - "url": "https://api.github.com/teams/2", - "name": "Original Roster", - "slug": "original-roster", - "description": "Started it all.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/2/members{/member}", - "repositories_url": "https://api.github.com/teams/2/repos", - "parent": { - "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" - }, - "html_url": "https://github.com/orgs/rails/teams/core" - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams" - } - } - }, - "/orgs/{org}/{security_product}/{enablement}": { - "post": { - "summary": "Enable or disable a security feature for an organization", - "description": "> [!WARNING]\n> **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/).\n\nEnables or disables the specified security feature for all eligible repositories in an organization. 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 organization owner or be member of a team with the security manager role to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/enable-or-disable-security-product-on-all-org-repos", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "security_product", - "in": "path", - "description": "The security feature to enable or disable.", - "required": true, - "schema": { - "type": "string", - "enum": [ - "dependency_graph", - "dependabot_alerts", - "dependabot_security_updates", - "advanced_security", - "code_scanning_default_setup", - "secret_scanning", - "secret_scanning_push_protection" - ] - } - }, - { - "name": "enablement", - "in": "path", - "description": "The action to take.\n\n`enable_all` means to enable the specified security feature for all repositories in the organization.\n`disable_all` means to disable the specified security feature for all repositories in the organization.", - "required": true, - "schema": { - "type": "string", - "enum": [ - "enable_all", - "disable_all" - ] - } } ], "requestBody": { @@ -178455,89 +170076,77 @@ "content": { "application/json": { "schema": { + "type": "object", "properties": { - "query_suite": { - "description": "CodeQL query suite to be used. If you specify the `query_suite` parameter, the default setup will be configured with this query suite only on all repositories that didn't have default setup already configured. It will not change the query suite on repositories that already have default setup configured.\nIf you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied.", + "name": { + "type": "string", + "description": "The name of the team." + }, + "description": { + "type": "string", + "description": "The description of the team." + }, + "privacy": { + "type": "string", + "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \n**For a parent or child team:** \n * `closed` - visible to all members of this organization.", + "enum": [ + "secret", + "closed" + ] + }, + "notification_setting": { "type": "string", + "description": "The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: \n * `notifications_enabled` - team members receive notifications when the team is @mentioned. \n * `notifications_disabled` - no one receives notifications.", "enum": [ - "default", - "extended" + "notifications_enabled", + "notifications_disabled" ] + }, + "permission": { + "type": "string", + "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.", + "enum": [ + "pull", + "push", + "admin" + ], + "default": "pull" + }, + "parent_team_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of a team to set as the parent team." } } }, "examples": { "default": { - "value": null + "value": { + "name": "new team name", + "description": "new team description", + "privacy": "closed", + "notification_setting": "notifications_enabled" + } } } } } }, - "responses": { - "204": { - "description": "Action started" - }, - "422": { - "description": "The action could not be taken due to an in progress enablement, or a policy is preventing enablement" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [], - "category": "orgs", - "subcategory": "orgs", - "deprecationDate": "2024-07-22", - "removalDate": "2025-07-22" - }, - "deprecated": true - } - }, - "/projects/columns/cards/{card_id}": { - "get": { - "summary": "Get a project card", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/get-card", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/cards#get-a-project-card" - }, - "parameters": [ - { - "name": "card_id", - "description": "The unique identifier of the card.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], "responses": { "200": { - "description": "Response", + "description": "Response when the updated information already exists", "content": { "application/json": { "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", + "title": "Full Team", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/cards/1478" - ] - }, "id": { - "description": "The project card's ID", + "description": "Unique identifier of the team", "type": "integer", - "format": "int64", "examples": [ 42 ] @@ -178545,515 +170154,101 @@ "node_id": { "type": "string", "examples": [ - "MDExOlByb2plY3RDYXJkMTQ3OA==" - ] - }, - "note": { - "type": [ - "string", - "null" - ], - "examples": [ - "Add payload for delete Project column" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "MDQ6VGVhbTE=" ] }, - "created_at": { + "url": { + "description": "URL for the team", "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2016-09-05T14:21:06Z" + "https://api.github.com/organizations/1/team/1" ] }, - "updated_at": { + "html_url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2016-09-05T14:20:22Z" + "https://github.com/orgs/rails/teams/core" ] }, - "archived": { - "description": "Whether or not the card is archived", - "type": "boolean", + "name": { + "description": "Name of the team", + "type": "string", "examples": [ - false + "Developers" ] }, - "column_name": { - "type": "string" - }, - "project_id": { - "type": "string" - }, - "column_url": { + "slug": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/projects/columns/367" + "justice-league" ] }, - "content_url": { - "type": "string", - "format": "uri", + "description": { + "type": [ + "string", + "null" + ], "examples": [ - "https://api.github.com/repos/api-playground/projects-test/issues/3" + "A great team." ] }, - "project_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", - "format": "uri", + "enum": [ + "closed", + "secret" + ], "examples": [ - "https://api.github.com/projects/120" + "closed" ] - } - }, - "required": [ - "id", - "node_id", - "note", - "url", - "column_url", - "project_url", - "creator", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", - "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 - }, - "created_at": "2016-09-05T14:21:06Z", - "updated_at": "2016-09-05T14:20:22Z", - "archived": false, - "column_url": "https://api.github.com/projects/columns/367", - "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", - "project_url": "https://api.github.com/projects/120" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "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" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/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": "projects-classic", - "subcategory": "cards", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "patch": { - "summary": "Update an existing project card", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/update-card", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/cards#update-an-existing-project-card" - }, - "parameters": [ - { - "name": "card_id", - "description": "The unique identifier of the card.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "note": { - "description": "The project card's note", - "type": [ - "string", - "null" - ], - "examples": [ - "Update all gems" - ] - }, - "archived": { - "description": "Whether or not the card is archived", - "type": "boolean", - "examples": [ - false - ] - } - } - }, - "examples": { - "default": { - "summary": "Change the note on the card", - "value": { - "note": "Add payload for delete Project column" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", - "type": "object", - "properties": { - "url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], "examples": [ - "https://api.github.com/projects/columns/cards/1478" + "notifications_enabled" ] }, - "id": { - "description": "The project card's ID", - "type": "integer", - "format": "int64", + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", "examples": [ - 42 + "push" ] }, - "node_id": { + "members_url": { "type": "string", "examples": [ - "MDExOlByb2plY3RDYXJkMTQ3OA==" + "https://api.github.com/organizations/1/team/1/members{/member}" ] }, - "note": { - "type": [ - "string", - "null" - ], + "repositories_url": { + "type": "string", + "format": "uri", "examples": [ - "Add payload for delete Project column" + "https://api.github.com/organizations/1/team/1/repos" ] }, - "creator": { + "parent": { "anyOf": [ { "type": "null" }, { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { + "description": "Unique identifier of the team", "type": "integer", - "format": "int64", "examples": [ 1 ] @@ -179061,596 +170256,1290 @@ "node_id": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "MDQ6VGVhbTE=" ] }, "url": { + "description": "URL for the team", "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" + "https://api.github.com/organizations/1/team/1" ] }, - "followers_url": { + "members_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/followers" + "https://api.github.com/organizations/1/team/1/members{/member}" ] }, - "following_url": { + "name": { + "description": "Name of the team", "type": "string", "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" + "Justice League" ] }, - "gists_url": { - "type": "string", + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" + "A great team." ] }, - "starred_url": { + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "admin" ] }, - "subscriptions_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "closed" ] }, - "organizations_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "notifications_enabled" ] }, - "repos_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "https://github.com/orgs/rails/teams/core" ] }, - "received_events_url": { + "repositories_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" + "https://api.github.com/organizations/1/team/1/repos" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { + "slug": { "type": "string", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "justice-league" ] }, - "user_view_type": { + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": [ - "public" + "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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" ] } ] }, - "created_at": { - "type": "string", - "format": "date-time", + "members_count": { + "type": "integer", "examples": [ - "2016-09-05T14:21:06Z" + 3 ] }, - "updated_at": { - "type": "string", - "format": "date-time", + "repos_count": { + "type": "integer", "examples": [ - "2016-09-05T14:20:22Z" + 10 ] }, - "archived": { - "description": "Whether or not the card is archived", - "type": "boolean", + "created_at": { + "type": "string", + "format": "date-time", "examples": [ - false + "2017-07-14T16:53:42Z" ] }, - "column_name": { - "type": "string" - }, - "project_id": { - "type": "string" - }, - "column_url": { + "updated_at": { "type": "string", - "format": "uri", + "format": "date-time", "examples": [ - "https://api.github.com/projects/columns/367" + "2017-08-17T12:37:15Z" ] }, - "content_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test/issues/3" + "organization": { + "title": "Team Organization", + "description": "Team Organization", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + }, + "name": { + "type": "string", + "examples": [ + "github" + ] + }, + "company": { + "type": "string", + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": "string", + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": "string", + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "github" + ] + }, + "is_verified": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_organization_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_repository_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "private_gists": { + "type": [ + "integer", + "null" + ], + "examples": [ + 81 + ] + }, + "disk_usage": { + "type": [ + "integer", + "null" + ], + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": [ + "integer", + "null" + ], + "examples": [ + 8 + ] + }, + "billing_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "org@example.com" + ] + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": [ + "string", + "null" + ] + }, + "members_can_create_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "two_factor_requirement_enabled": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "members_allowed_repository_creation_type": { + "type": "string", + "examples": [ + "all" + ] + }, + "members_can_create_public_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_public_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_fork_private_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "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" ] }, - "project_url": { + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/projects/120" + "uid=example,ou=users,dc=github,dc=com" ] } }, "required": [ "id", "node_id", - "note", "url", - "column_url", - "project_url", - "creator", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", "created_at", - "updated_at" + "updated_at", + "members_count", + "repos_count", + "organization" ] }, "examples": { "default": { "value": { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", - "creator": { - "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, + "members_count": 3, + "repos_count": 10, + "created_at": "2017-07-14T16:53:42Z", + "updated_at": "2017-08-17T12:37:15Z", + "organization": { + "login": "github", "id": 1, - "node_id": "MDQ6VXNlcjE=", + "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", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "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", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "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": "2016-09-05T14:21:06Z", - "updated_at": "2016-09-05T14:20:22Z", - "archived": false, - "column_url": "https://api.github.com/projects/columns/367", - "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", - "project_url": "https://api.github.com/projects/120" + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + } } } } } } }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", + "201": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Full Team", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "message": { - "type": "string" + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 42 + ] }, - "documentation_url": { - "type": "string" + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] }, "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" + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] }, - "documentation_url": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] }, - "url": { - "type": "string" + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Developers" + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] }, - "documentation_url": { - "type": "string" + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] }, - "url": { - "type": "string" + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": [ + "closed", + "secret" + ], + "examples": [ + "closed" + ] }, - "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" + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "examples": [ + "notifications_enabled" + ] }, - "documentation_url": { - "type": "string" + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "push" + ] }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "cards", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Delete a project card", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/delete-card", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/cards#delete-a-project-card" - }, - "parameters": [ - { - "name": "card_id", - "description": "The unique identifier of the card.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] }, - "documentation_url": { - "type": "string" + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] }, - "documentation_url": { - "type": "string" + "members_count": { + "type": "integer", + "examples": [ + 3 + ] }, - "url": { - "type": "string" + "repos_count": { + "type": "integer", + "examples": [ + 10 + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-14T16:53:42Z" + ] }, - "documentation_url": { - "type": "string" + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-08-17T12:37:15Z" + ] }, - "url": { - "type": "string" + "organization": { + "title": "Team Organization", + "description": "Team Organization", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + }, + "name": { + "type": "string", + "examples": [ + "github" + ] + }, + "company": { + "type": "string", + "examples": [ + "GitHub" + ] + }, + "blog": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/blog" + ] + }, + "location": { + "type": "string", + "examples": [ + "San Francisco" + ] + }, + "email": { + "type": "string", + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, + "twitter_username": { + "type": [ + "string", + "null" + ], + "examples": [ + "github" + ] + }, + "is_verified": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_organization_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_repository_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "public_repos": { + "type": "integer", + "examples": [ + 2 + ] + }, + "public_gists": { + "type": "integer", + "examples": [ + 1 + ] + }, + "followers": { + "type": "integer", + "examples": [ + 20 + ] + }, + "following": { + "type": "integer", + "examples": [ + 0 + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2008-01-14T04:33:35Z" + ] + }, + "type": { + "type": "string", + "examples": [ + "Organization" + ] + }, + "total_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "owned_private_repos": { + "type": "integer", + "examples": [ + 100 + ] + }, + "private_gists": { + "type": [ + "integer", + "null" + ], + "examples": [ + 81 + ] + }, + "disk_usage": { + "type": [ + "integer", + "null" + ], + "examples": [ + 10000 + ] + }, + "collaborators": { + "type": [ + "integer", + "null" + ], + "examples": [ + 8 + ] + }, + "billing_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "org@example.com" + ] + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": [ + "string", + "null" + ] + }, + "members_can_create_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "two_factor_requirement_enabled": { + "type": [ + "boolean", + "null" + ], + "examples": [ + true + ] + }, + "members_allowed_repository_creation_type": { + "type": "string", + "examples": [ + "all" + ] + }, + "members_can_create_public_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_public_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_create_private_pages": { + "type": "boolean", + "examples": [ + true + ] + }, + "members_can_fork_private_repositories": { + "type": [ + "boolean", + "null" + ], + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "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" + ] }, - "status": { - "type": "string" + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "cards", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/columns/cards/{card_id}/moves": { - "post": { - "summary": "Move a project card", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/move-card", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/cards#move-a-project-card" - }, - "parameters": [ - { - "name": "card_id", - "description": "The unique identifier of the card.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "position": { - "description": "The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card.", - "type": "string", - "pattern": "^(?:top|bottom|after:\\d+)$", - "examples": [ - "bottom" - ] }, - "column_id": { - "description": "The unique identifier of the column the card should be moved to", - "type": "integer", - "examples": [ - 42 - ] - } - }, - "required": [ - "position" - ], - "type": "object" - }, - "examples": { - "default": { - "summary": "Move the card to the bottom of the column", - "value": { - "column_id": 42, - "position": "bottom" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "additionalProperties": false + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "created_at", + "updated_at", + "members_count", + "repos_count", + "organization" + ] }, "examples": { "default": { - "value": null - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "resource": { - "type": "string" - }, - "field": { - "type": "string" - } - } + "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, + "members_count": 3, + "repos_count": 10, + "created_at": "2017-07-14T16:53:42Z", + "updated_at": "2017-08-17T12:37:15Z", + "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", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "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", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" } } } @@ -179658,8 +171547,8 @@ } } }, - "401": { - "description": "Requires authentication", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -179684,41 +171573,6 @@ } } }, - "503": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - } - } - } - } - } - } - } - } - }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { @@ -179793,138 +171647,6 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "cards", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/columns/{column_id}": { - "get": { - "summary": "Get a project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/get-column", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#get-a-project-column" - }, - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - }, - "cards_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367/cards" - ] - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" - ] - }, - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:18:44Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:22:28Z" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - } - } - } - } - } - }, - "304": { - "description": "Not modified" }, "403": { "description": "Forbidden", @@ -179951,410 +171673,102 @@ } } } - }, - "404": { - "description": "Resource not found", - "content": { - "application/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": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true + "category": "teams", + "subcategory": "teams" + } }, - "patch": { - "summary": "Update an existing project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "delete": { + "summary": "Delete a team", + "description": "To delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`.", "tags": [ - "projects-classic" + "teams" ], - "operationId": "projects-classic/update-column", + "operationId": "teams/delete-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#update-an-existing-project-column" + "url": "https://docs.github.com/rest/teams/teams#delete-a-team" }, "parameters": [ { - "name": "column_id", - "description": "The unique identifier of the column.", + "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": { - "properties": { - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" - ] - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "examples": { - "default": { - "summary": "Rename the project column", - "value": { - "name": "To Do" - } - } - } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" } } - }, + ], "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - }, - "cards_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367/cards" - ] - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" - ] - }, - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:18:44Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:22:28Z" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "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" - } - } - } - } - } + "204": { + "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Delete a project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "category": "teams", + "subcategory": "teams" + } + } + }, + "/orgs/{org}/teams/{team_slug}/discussions": { + "get": { + "summary": "List discussions", + "description": "List all discussions on a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ - "projects-classic" + "teams" ], - "operationId": "projects-classic/delete-column", + "operationId": "teams/list-discussions-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#delete-a-project-column" + "url": "https://docs.github.com/rest/teams/discussions#list-discussions" }, "parameters": [ { - "name": "column_id", - "description": "The unique identifier of the column.", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } - } - ], - "responses": { - "204": { - "description": "Response" }, - "304": { - "description": "Not modified" + { + "name": "team_slug", + "description": "The slug of the team name.", + "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" - } - } - } - } - } - }, - "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": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/columns/{column_id}/cards": { - "get": { - "summary": "List project cards", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/list-cards", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/cards#list-project-cards" - }, - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "archived_state", - "description": "Filters the project cards that are returned by the card's state.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "all", - "archived", - "not_archived" - ], - "default": "not_archived" + { + "name": "direction", + "description": "The direction to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" } }, { @@ -180374,6 +171788,15 @@ "type": "integer", "default": 1 } + }, + { + "name": "pinned", + "in": "query", + "required": false, + "description": "Pinned discussions only filter", + "schema": { + "type": "string" + } } ], "responses": { @@ -180384,41 +171807,11 @@ "schema": { "type": "array", "items": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", + "title": "Team Discussion", + "description": "A team discussion is a persistent record of a free-form conversation within a team.", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/cards/1478" - ] - }, - "id": { - "description": "The project card's ID", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOlByb2plY3RDYXJkMTQ3OA==" - ] - }, - "note": { - "type": [ - "string", - "null" - ], - "examples": [ - "Add payload for delete Project column" - ] - }, - "creator": { + "author": { "anyOf": [ { "type": "null" @@ -180593,65 +171986,183 @@ } ] }, + "body": { + "description": "The main text of the discussion.", + "type": "string", + "examples": [ + "Please suggest improvements to our workflow in comments." + ] + }, + "body_html": { + "type": "string", + "examples": [ + "

Hi! This is an area for us to collaborate as a team

" + ] + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "type": "string", + "examples": [ + "0307116bbf7ced493b8d8a346c650b71" + ] + }, + "comments_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + ] + }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:21:06Z" + "2018-01-25T18:56:31Z" ] }, - "updated_at": { + "last_edited_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2016-09-05T14:20:22Z" + "https://github.com/orgs/github/teams/justice-league/discussions/1" ] }, - "archived": { - "description": "Whether or not the card is archived", - "type": "boolean", + "node_id": { + "type": "string", "examples": [ - false + "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" ] }, - "column_name": { - "type": "string" + "number": { + "description": "The unique sequence number of a team discussion.", + "type": "integer", + "examples": [ + 42 + ] }, - "project_id": { - "type": "string" + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "type": "boolean", + "examples": [ + true + ] }, - "column_url": { + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "type": "boolean", + "examples": [ + true + ] + }, + "team_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/367" + "https://api.github.com/organizations/1/team/2343027" ] }, - "content_url": { + "title": { + "description": "The title of the discussion.", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/repos/api-playground/projects-test/issues/3" + "How can we improve our workflow?" ] }, - "project_url": { + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-01-25T18:56:31Z" + ] + }, + "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/120" + "https://api.github.com/organizations/1/team/2343027/discussions/1" + ] + }, + "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", - "note", - "url", - "column_url", - "project_url", - "creator", + "author", + "body", + "body_html", + "body_version", + "comments_count", + "comments_url", "created_at", - "updated_at" + "last_edited_at", + "html_url", + "pinned", + "private", + "node_id", + "number", + "team_url", + "title", + "updated_at", + "url" ] } }, @@ -180659,11 +172170,7 @@ "default": { "value": [ { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", - "creator": { + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -180683,12 +172190,34 @@ "type": "User", "site_admin": false }, - "created_at": "2016-09-05T14:21:06Z", - "updated_at": "2016-09-05T14:20:22Z", - "archived": false, - "column_url": "https://api.github.com/projects/columns/367", - "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", - "project_url": "https://api.github.com/projects/120" + "body": "Hi! This is an area for us to collaborate as a team.", + "body_html": "

Hi! This is an area for us to collaborate as a team

", + "body_version": "0d495416a700fb06133c612575d92bfb", + "comments_count": 0, + "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", + "created_at": "2018-01-25T18:56:31Z", + "last_edited_at": null, + "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", + "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", + "number": 1, + "pinned": false, + "private": false, + "team_url": "https://api.github.com/teams/2343027", + "title": "Our first team post", + "updated_at": "2018-01-25T18:56:31Z", + "url": "https://api.github.com/teams/2343027/discussions/1", + "reactions": { + "url": "https://api.github.com/teams/2343027/discussions/1/reactions", + "total_count": 5, + "+1": 3, + "-1": 1, + "laugh": 0, + "confused": 0, + "heart": 1, + "hooray": 0, + "eyes": 1, + "rocket": 1 + } } ] } @@ -180703,92 +172232,43 @@ } } } - }, - "304": { - "description": "Not modified" - }, - "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": true, - "category": "projects-classic", - "subcategory": "cards", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true + "category": "teams", + "subcategory": "discussions" + } }, "post": { - "summary": "Create a project card", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "summary": "Create a discussion", + "description": "Creates a new discussion post on a team's page.\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)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ - "projects-classic" + "teams" ], - "operationId": "projects-classic/create-card", + "operationId": "teams/create-discussion-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/cards#create-a-project-card" + "url": "https://docs.github.com/rest/teams/discussions#create-a-discussion" }, "parameters": [ { - "name": "column_id", - "description": "The unique identifier of the column.", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" } } ], @@ -180797,55 +172277,32 @@ "content": { "application/json": { "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "note": { - "description": "The project card's note", - "type": [ - "string", - "null" - ], - "examples": [ - "Update all gems" - ] - } - }, - "required": [ - "note" - ] + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The discussion post's title." }, - { - "type": "object", - "properties": { - "content_id": { - "description": "The unique identifier of the content associated with the card", - "type": "integer", - "examples": [ - 42 - ] - }, - "content_type": { - "description": "The piece of content associated with the card", - "type": "string", - "examples": [ - "PullRequest" - ] - } - }, - "required": [ - "content_id", - "content_type" - ] + "body": { + "type": "string", + "description": "The discussion post's body text." + }, + "private": { + "type": "boolean", + "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.", + "default": false } + }, + "required": [ + "title", + "body" ] }, "examples": { "default": { - "summary": "Create a new card", "value": { - "note": "Add payload for delete Project column" + "title": "Our first team post", + "body": "Hi! This is an area for us to collaborate as a team." } } } @@ -180858,41 +172315,11 @@ "content": { "application/json": { "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", + "title": "Team Discussion", + "description": "A team discussion is a persistent record of a free-form conversation within a team.", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/cards/1478" - ] - }, - "id": { - "description": "The project card's ID", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOlByb2plY3RDYXJkMTQ3OA==" - ] - }, - "note": { - "type": [ - "string", - "null" - ], - "examples": [ - "Add payload for delete Project column" - ] - }, - "creator": { + "author": { "anyOf": [ { "type": "null" @@ -181067,75 +172494,189 @@ } ] }, + "body": { + "description": "The main text of the discussion.", + "type": "string", + "examples": [ + "Please suggest improvements to our workflow in comments." + ] + }, + "body_html": { + "type": "string", + "examples": [ + "

Hi! This is an area for us to collaborate as a team

" + ] + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "type": "string", + "examples": [ + "0307116bbf7ced493b8d8a346c650b71" + ] + }, + "comments_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + ] + }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:21:06Z" + "2018-01-25T18:56:31Z" ] }, - "updated_at": { + "last_edited_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2016-09-05T14:20:22Z" + "https://github.com/orgs/github/teams/justice-league/discussions/1" ] }, - "archived": { - "description": "Whether or not the card is archived", - "type": "boolean", + "node_id": { + "type": "string", "examples": [ - false + "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" ] }, - "column_name": { - "type": "string" + "number": { + "description": "The unique sequence number of a team discussion.", + "type": "integer", + "examples": [ + 42 + ] }, - "project_id": { - "type": "string" + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "type": "boolean", + "examples": [ + true + ] }, - "column_url": { + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "type": "boolean", + "examples": [ + true + ] + }, + "team_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/367" + "https://api.github.com/organizations/1/team/2343027" ] }, - "content_url": { + "title": { + "description": "The title of the discussion.", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/repos/api-playground/projects-test/issues/3" + "How can we improve our workflow?" ] }, - "project_url": { + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-01-25T18:56:31Z" + ] + }, + "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/120" + "https://api.github.com/organizations/1/team/2343027/discussions/1" + ] + }, + "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", - "note", - "url", - "column_url", - "project_url", - "creator", + "author", + "body", + "body_html", + "body_version", + "comments_count", + "comments_url", "created_at", - "updated_at" + "last_edited_at", + "html_url", + "pinned", + "private", + "node_id", + "number", + "team_url", + "title", + "updated_at", + "url" ] }, "examples": { "default": { "value": { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", - "creator": { + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -181155,203 +172696,33 @@ "type": "User", "site_admin": false }, - "created_at": "2016-09-05T14:21:06Z", - "updated_at": "2016-09-05T14:20:22Z", - "archived": false, - "column_url": "https://api.github.com/projects/columns/367", - "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", - "project_url": "https://api.github.com/projects/120" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "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" - } - } - } - } - } - }, - "422": { - "description": "Validation failed", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - }, - { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - ] - } - } - } - }, - "503": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - } - } + "body": "Hi! This is an area for us to collaborate as a team.", + "body_html": "

Hi! This is an area for us to collaborate as a team

", + "body_version": "0d495416a700fb06133c612575d92bfb", + "comments_count": 0, + "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", + "created_at": "2018-01-25T18:56:31Z", + "last_edited_at": null, + "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", + "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", + "number": 1, + "pinned": false, + "private": false, + "team_url": "https://api.github.com/teams/2343027", + "title": "Our first team post", + "updated_at": "2018-01-25T18:56:31Z", + "url": "https://api.github.com/teams/2343027/discussions/1", + "reactions": { + "url": "https://api.github.com/teams/2343027/discussions/1/reactions", + "total_count": 5, + "+1": 3, + "-1": 1, + "laugh": 0, + "confused": 0, + "heart": 1, + "hooray": 0, + "eyes": 1, + "rocket": 1 } } } @@ -181361,201 +172732,48 @@ } }, "x-github": { + "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "cards", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true + "category": "teams", + "subcategory": "discussions" + } } }, - "/projects/columns/{column_id}/moves": { - "post": { - "summary": "Move a project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": { + "get": { + "summary": "Get a discussion", + "description": "Get a specific discussion on a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ - "projects-classic" + "teams" ], - "operationId": "projects-classic/move-column", + "operationId": "teams/get-discussion-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#move-a-project-column" + "url": "https://docs.github.com/rest/teams/discussions#get-a-discussion" }, "parameters": [ { - "name": "column_id", - "description": "The unique identifier of the column.", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "position": { - "description": "The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column.", - "type": "string", - "pattern": "^(?:first|last|after:\\d+)$", - "examples": [ - "last" - ] - } - }, - "required": [ - "position" - ], - "type": "object" - }, - "examples": { - "default": { - "summary": "Move the column to the end of the board", - "value": { - "position": "last" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "additionalProperties": false - }, - "examples": { - "default": { - "value": null - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "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" - } - } - } - } + "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" - } - } - } - } - } + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "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": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}": { - "get": { - "summary": "Get a project", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/get", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#get-a-project" - }, - "parameters": [ { - "name": "project_id", - "description": "The unique identifier of the project.", + "name": "discussion_number", + "description": "The number that identifies the discussion.", "in": "path", "required": true, "schema": { @@ -181569,81 +172787,11 @@ "content": { "application/json": { "schema": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", + "title": "Team Discussion", + "description": "A team discussion is a persistent record of a free-form conversation within a team.", "type": "object", "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "creator": { + "author": { "anyOf": [ { "type": "null" @@ -181818,65 +172966,189 @@ } ] }, + "body": { + "description": "The main text of the discussion.", + "type": "string", + "examples": [ + "Please suggest improvements to our workflow in comments." + ] + }, + "body_html": { + "type": "string", + "examples": [ + "

Hi! This is an area for us to collaborate as a team

" + ] + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "type": "string", + "examples": [ + "0307116bbf7ced493b8d8a346c650b71" + ] + }, + "comments_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + ] + }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2011-04-10T20:09:31Z" + "2018-01-25T18:56:31Z" + ] + }, + "last_edited_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/github/teams/justice-league/discussions/1" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" + ] + }, + "number": { + "description": "The unique sequence number of a team discussion.", + "type": "integer", + "examples": [ + 42 + ] + }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "type": "boolean", + "examples": [ + true + ] + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "type": "boolean", + "examples": [ + true + ] + }, + "team_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027" + ] + }, + "title": { + "description": "The title of the discussion.", + "type": "string", + "examples": [ + "How can we improve our workflow?" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2014-03-03T18:58:10Z" + "2018-01-25T18:56:31Z" ] }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "url": { "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027/discussions/1" ] }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" + "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", - "number", - "name", + "author", "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", + "body_html", + "body_version", + "comments_count", + "comments_url", "created_at", - "updated_at" + "last_edited_at", + "html_url", + "pinned", + "private", + "node_id", + "number", + "team_url", + "title", + "updated_at", + "url" ] }, "examples": { "default": { "value": { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "number": 1, - "state": "open", - "creator": { + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -181896,63 +173168,34 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "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" + "body": "Hi! This is an area for us to collaborate as a team.", + "body_html": "

Hi! This is an area for us to collaborate as a team

", + "body_version": "0d495416a700fb06133c612575d92bfb", + "comments_count": 0, + "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", + "created_at": "2018-01-25T18:56:31Z", + "last_edited_at": null, + "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", + "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", + "number": 1, + "pinned": false, + "private": false, + "team_url": "https://api.github.com/teams/2343027", + "title": "Our first team post", + "updated_at": "2018-01-25T18:56:31Z", + "url": "https://api.github.com/teams/2343027/discussions/1", + "reactions": { + "url": "https://api.github.com/teams/2343027/discussions/1/reactions", + "total_count": 5, + "+1": 3, + "-1": 1, + "laugh": 0, + "confused": 0, + "heart": 1, + "hooray": 0, + "eyes": 1, + "rocket": 1 + } } } } @@ -181963,28 +173206,43 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true + "category": "teams", + "subcategory": "discussions" + } }, "patch": { - "summary": "Update a project", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "operationId": "projects-classic/update", + "summary": "Update a discussion", + "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ - "projects-classic" + "teams" ], + "operationId": "teams/update-discussion-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#update-a-project" + "url": "https://docs.github.com/rest/teams/discussions#update-a-discussion" }, "parameters": [ { - "name": "project_id", - "description": "The unique identifier of the project.", + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discussion_number", + "description": "The number that identifies the discussion.", "in": "path", "required": true, "schema": { @@ -181997,55 +173255,22 @@ "content": { "application/json": { "schema": { + "type": "object", "properties": { - "name": { - "description": "Name of the project", + "title": { "type": "string", - "examples": [ - "Week One Sprint" - ] + "description": "The discussion post's title." }, "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project", "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone.", - "type": "boolean" + "description": "The discussion post's body text." } - }, - "type": "object" + } }, "examples": { "default": { - "summary": "Change the name, state, and permissions for a project", "value": { - "name": "Week One Sprint", - "state": "open", - "organization_permission": "write" + "title": "Welcome to our first team post" } } } @@ -182058,81 +173283,11 @@ "content": { "application/json": { "schema": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", + "title": "Team Discussion", + "description": "A team discussion is a persistent record of a free-form conversation within a team.", "type": "object", "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "creator": { + "author": { "anyOf": [ { "type": "null" @@ -182307,65 +173462,189 @@ } ] }, + "body": { + "description": "The main text of the discussion.", + "type": "string", + "examples": [ + "Please suggest improvements to our workflow in comments." + ] + }, + "body_html": { + "type": "string", + "examples": [ + "

Hi! This is an area for us to collaborate as a team

" + ] + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "type": "string", + "examples": [ + "0307116bbf7ced493b8d8a346c650b71" + ] + }, + "comments_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + ] + }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2011-04-10T20:09:31Z" + "2018-01-25T18:56:31Z" + ] + }, + "last_edited_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/github/teams/justice-league/discussions/1" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" + ] + }, + "number": { + "description": "The unique sequence number of a team discussion.", + "type": "integer", + "examples": [ + 42 + ] + }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "type": "boolean", + "examples": [ + true + ] + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization owners.", + "type": "boolean", + "examples": [ + true + ] + }, + "team_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027" + ] + }, + "title": { + "description": "The title of the discussion.", + "type": "string", + "examples": [ + "How can we improve our workflow?" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2014-03-03T18:58:10Z" + "2018-01-25T18:56:31Z" ] }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "url": { "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2343027/discussions/1" ] }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" + "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", - "number", - "name", + "author", "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", + "body_html", + "body_version", + "comments_count", + "comments_url", "created_at", - "updated_at" + "last_edited_at", + "html_url", + "pinned", + "private", + "node_id", + "number", + "team_url", + "title", + "updated_at", + "url" ] }, "examples": { "default": { "value": { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "number": 1, - "state": "open", - "creator": { + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -182385,119 +173664,33 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - } - } - } - } - } - }, - "404": { - "description": "Not Found if the authenticated user does not have access to the project" - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "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" - } - } - } - } - } - }, - "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 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" + "body": "Hi! This is an area for us to collaborate as a team.", + "body_html": "

Hi! This is an area for us to collaborate as a team

", + "body_version": "0d495416a700fb06133c612575d92bfb", + "comments_count": 1, + "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", + "created_at": "2018-01-25T18:56:31Z", + "last_edited_at": "2018-01-26T18:22:20Z", + "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", + "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", + "number": 1, + "pinned": false, + "private": false, + "team_url": "https://api.github.com/teams/2343027", + "title": "Welcome to our first team post", + "updated_at": "2018-01-26T18:22:20Z", + "url": "https://api.github.com/teams/2343027/discussions/1", + "reactions": { + "url": "https://api.github.com/teams/2343027/discussions/1/reactions", + "total_count": 5, + "+1": 3, + "-1": 1, + "laugh": 0, + "confused": 0, + "heart": 1, + "hooray": 0, + "eyes": 1, + "rocket": 1 } } } @@ -182509,28 +173702,43 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true + "category": "teams", + "subcategory": "discussions" + } }, "delete": { - "summary": "Delete a project", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "operationId": "projects-classic/delete", + "summary": "Delete a discussion", + "description": "Delete a discussion from a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ - "projects-classic" + "teams" ], + "operationId": "teams/delete-discussion-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#delete-a-project" + "url": "https://docs.github.com/rest/teams/discussions#delete-a-discussion" }, "parameters": [ { - "name": "project_id", - "description": "The unique identifier of the project.", + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discussion_number", + "description": "The number that identifies the discussion.", "in": "path", "required": true, "schema": { @@ -182540,141 +173748,51 @@ ], "responses": { "204": { - "description": "Delete Success" + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "discussions" + } + } + }, + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": { + "get": { + "summary": "List discussion comments", + "description": "List all comments on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "tags": [ + "teams" + ], + "operationId": "teams/list-discussion-comments-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "304": { - "description": "Not modified" + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "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" - } - } - } - } - } - }, - "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" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/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": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}/collaborators": { - "get": { - "summary": "List project collaborators", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/list-collaborators", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#list-project-collaborators" - }, - "parameters": [ { - "name": "project_id", - "description": "The unique identifier of the project.", + "name": "discussion_number", + "description": "The number that identifies the discussion.", "in": "path", "required": true, "schema": { @@ -182682,18 +173800,17 @@ } }, { - "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 organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see.", + "name": "direction", + "description": "The direction to sort the results by.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ - "outside", - "direct", - "all" + "asc", + "desc" ], - "default": "all" + "default": "desc" } }, { @@ -182723,170 +173840,322 @@ "schema": { "type": "array", "items": { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Team Discussion Comment", + "description": "A reply to a discussion within a team.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } ] }, - "login": { + "body": { + "description": "The main text of the comment.", "type": "string", "examples": [ - "octocat" + "I agree with this suggestion." ] }, - "id": { - "type": "integer", - "format": "int64", + "body_html": { + "type": "string", "examples": [ - 1 + "

Do you like apples?

" ] }, - "node_id": { + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", "type": "string", "examples": [ - "MDQ6VXNlcjE=" + "0307116bbf7ced493b8d8a346c650b71" ] }, - "avatar_url": { + "created_at": { "type": "string", - "format": "uri", + "format": "date-time", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "2018-01-15T23:53:58Z" ] }, - "gravatar_id": { + "last_edited_at": { "type": [ "string", "null" ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] + "format": "date-time" }, - "url": { + "discussion_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "https://api.github.com/organizations/1/team/2403582/discussions/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" ] }, - "organizations_url": { + "node_id": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" ] }, - "repos_url": { - "type": "string", - "format": "uri", + "number": { + "description": "The unique sequence number of a team discussion comment.", + "type": "integer", "examples": [ - "https://api.github.com/users/octocat/repos" + 42 ] }, - "events_url": { + "updated_at": { "type": "string", + "format": "date-time", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "2018-01-15T23:53:58Z" ] }, - "received_events_url": { + "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" + "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" ] }, - "user_view_type": { - "type": "string", - "examples": [ - "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", + "author", + "body", + "body_html", + "body_version", + "created_at", + "last_edited_at", + "discussion_url", "html_url", - "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", + "number", + "updated_at", "url" ] } @@ -182895,24 +174164,49 @@ "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 + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Do you like apples?", + "body_html": "

Do you like apples?

", + "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51", + "created_at": "2018-01-15T23:53:58Z", + "last_edited_at": null, + "discussion_url": "https://api.github.com/teams/2403582/discussions/1", + "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", + "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", + "number": 1, + "updated_at": "2018-01-15T23:53:58Z", + "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", + "reactions": { + "url": "https://api.github.com/teams/2403582/discussions/1/reactions", + "total_count": 5, + "+1": 3, + "-1": 1, + "laugh": 0, + "confused": 0, + "heart": 1, + "hooray": 0, + "eyes": 1, + "rocket": 1 + } } ] } @@ -182927,237 +174221,75 @@ } } } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "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": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}/collaborators/{username}": { - "put": { - "summary": "Add project collaborator", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "category": "teams", + "subcategory": "discussion-comments" + } + }, + "post": { + "summary": "Create a discussion comment", + "description": "Creates a new comment on a team discussion.\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)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ - "projects-classic" + "teams" ], - "operationId": "projects-classic/add-collaborator", + "operationId": "teams/create-discussion-comment-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#add-project-collaborator" + "url": "https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment" }, "parameters": [ { - "name": "project_id", - "description": "The unique identifier of the project.", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } }, { - "name": "username", - "description": "The handle for the GitHub user account.", + "name": "team_slug", + "description": "The slug of the team name.", "in": "path", "required": true, "schema": { "type": "string" } + }, + { + "name": "discussion_number", + "description": "The number that identifies the discussion.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { - "type": [ - "object", - "null" - ], + "type": "object", "properties": { - "permission": { - "description": "The permission to grant the collaborator.", - "enum": [ - "read", - "write", - "admin" - ], - "default": "write", + "body": { "type": "string", - "examples": [ - "write" - ] + "description": "The discussion comment's body text." } - } + }, + "required": [ + "body" + ] }, "examples": { "default": { - "summary": "Applying write permissions for the new collaborator", "value": { - "permission": "write" + "body": "Do you like apples?" } } } @@ -183165,159 +174297,376 @@ } }, "responses": { - "204": { - "description": "Response" - }, - "404": { - "description": "Resource not found", + "201": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Team Discussion Comment", + "description": "A reply to a discussion within a team.", "type": "object", "properties": { - "message": { - "type": "string" + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] }, - "documentation_url": { - "type": "string" + "body": { + "description": "The main text of the comment.", + "type": "string", + "examples": [ + "I agree with this suggestion." + ] }, - "url": { - "type": "string" + "body_html": { + "type": "string", + "examples": [ + "

Do you like apples?

" + ] }, - "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" + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "type": "string", + "examples": [ + "0307116bbf7ced493b8d8a346c650b71" + ] }, - "documentation_url": { - "type": "string" + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-01-15T23:53:58Z" + ] }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "last_edited_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - "documentation_url": { - "type": "string" + "discussion_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1" + ] }, - "url": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "node_id": { + "type": "string", + "examples": [ + "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + ] }, - "documentation_url": { - "type": "string" + "number": { + "description": "The unique sequence number of a team discussion comment.", + "type": "integer", + "examples": [ + 42 + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-01-15T23:53:58Z" + ] }, "url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + ] }, - "status": { - "type": "string" + "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": [ + "author", + "body", + "body_html", + "body_version", + "created_at", + "last_edited_at", + "discussion_url", + "html_url", + "node_id", + "number", + "updated_at", + "url" + ] + }, + "examples": { + "default": { + "value": { + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Do you like apples?", + "body_html": "

Do you like apples?

", + "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51", + "created_at": "2018-01-15T23:53:58Z", + "last_edited_at": null, + "discussion_url": "https://api.github.com/teams/2403582/discussions/1", + "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", + "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", + "number": 1, + "updated_at": "2018-01-15T23:53:58Z", + "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", + "reactions": { + "url": "https://api.github.com/teams/2403582/discussions/1/reactions", + "total_count": 5, + "+1": 3, + "-1": 1, + "laugh": 0, + "confused": 0, + "heart": 1, + "hooray": 0, + "eyes": 1, + "rocket": 1 + } } } } @@ -183326,234 +174675,48 @@ } }, "x-github": { + "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Remove user as a collaborator", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "category": "teams", + "subcategory": "discussion-comments" + } + } + }, + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": { + "get": { + "summary": "Get a discussion comment", + "description": "Get a specific comment on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ - "projects-classic" + "teams" ], - "operationId": "projects-classic/remove-collaborator", + "operationId": "teams/get-discussion-comment-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#remove-user-as-a-collaborator" + "url": "https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment" }, "parameters": [ { - "name": "project_id", - "description": "The unique identifier of the project.", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } }, { - "name": "username", - "description": "The handle for the GitHub user account.", + "name": "team_slug", + "description": "The slug of the team name.", "in": "path", "required": true, "schema": { "type": "string" } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "304": { - "description": "Not modified" - }, - "404": { - "description": "Resource not found", - "content": { - "application/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" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } }, - "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": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}/collaborators/{username}/permission": { - "get": { - "summary": "Get project permission for a user", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/get-permission-for-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#get-project-permission-for-a-user" - }, - "parameters": [ { - "name": "project_id", - "description": "The unique identifier of the project.", + "name": "discussion_number", + "description": "The number that identifies the discussion.", "in": "path", "required": true, "schema": { @@ -183561,12 +174724,12 @@ } }, { - "name": "username", - "description": "The handle for the GitHub user account.", + "name": "comment_number", + "description": "The number that identifies the comment.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], @@ -183576,14 +174739,11 @@ "content": { "application/json": { "schema": { - "title": "Project Collaborator Permission", - "description": "Project Collaborator Permission", + "title": "Team Discussion Comment", + "description": "A reply to a discussion within a team.", "type": "object", "properties": { - "permission": { - "type": "string" - }, - "user": { + "author": { "anyOf": [ { "type": "null" @@ -183757,18 +174917,151 @@ ] } ] + }, + "body": { + "description": "The main text of the comment.", + "type": "string", + "examples": [ + "I agree with this suggestion." + ] + }, + "body_html": { + "type": "string", + "examples": [ + "

Do you like apples?

" + ] + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "type": "string", + "examples": [ + "0307116bbf7ced493b8d8a346c650b71" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-01-15T23:53:58Z" + ] + }, + "last_edited_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "discussion_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + ] + }, + "number": { + "description": "The unique sequence number of a team discussion comment.", + "type": "integer", + "examples": [ + 42 + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-01-15T23:53:58Z" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + ] + }, + "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": [ - "permission", - "user" + "author", + "body", + "body_html", + "body_version", + "created_at", + "last_edited_at", + "discussion_url", + "html_url", + "node_id", + "number", + "updated_at", + "url" ] }, "examples": { "default": { "value": { - "permission": "admin", - "user": { + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -183787,410 +175080,979 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false + }, + "body": "Do you like apples?", + "body_html": "

Do you like apples?

", + "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51", + "created_at": "2018-01-15T23:53:58Z", + "last_edited_at": null, + "discussion_url": "https://api.github.com/teams/2403582/discussions/1", + "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", + "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", + "number": 1, + "updated_at": "2018-01-15T23:53:58Z", + "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", + "reactions": { + "url": "https://api.github.com/teams/2403582/discussions/1/reactions", + "total_count": 5, + "+1": 3, + "-1": 1, + "laugh": 0, + "confused": 0, + "heart": 1, + "hooray": 0, + "eyes": 1, + "rocket": 1 } } } } } } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "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": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}/columns": { - "get": { - "summary": "List project columns", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "category": "teams", + "subcategory": "discussion-comments" + } + }, + "patch": { + "summary": "Update a discussion comment", + "description": "Edits the body text of a discussion comment.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ - "projects-classic" + "teams" ], - "operationId": "projects-classic/list-columns", + "operationId": "teams/update-discussion-comment-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#list-project-columns" + "url": "https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment" }, "parameters": [ { - "name": "project_id", - "description": "The unique identifier of the project.", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" + "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", + "name": "team_slug", + "description": "The slug of the team name.", + "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": "discussion_number", + "description": "The number that identifies the discussion.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" + } + }, + { + "name": "comment_number", + "description": "The number that identifies the comment.", + "in": "path", + "required": true, + "schema": { + "type": "integer" } } ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - }, - "cards_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367/cards" - ] - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" - ] - }, - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:18:44Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:22:28Z" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "created_at", - "updated_at" - ] + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "type": "string", + "description": "The discussion comment's body text." } }, - "examples": { - "default": { - "value": [ - { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - } - ] + "required": [ + "body" + ] + }, + "examples": { + "default": { + "value": { + "body": "Do you like pineapples?" } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", + } + }, + "responses": { + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Team Discussion Comment", + "description": "A reply to a discussion within a team.", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "body": { + "description": "The main text of the comment.", + "type": "string", + "examples": [ + "I agree with this suggestion." + ] + }, + "body_html": { + "type": "string", + "examples": [ + "

Do you like apples?

" + ] + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "type": "string", + "examples": [ + "0307116bbf7ced493b8d8a346c650b71" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-01-15T23:53:58Z" + ] + }, + "last_edited_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "discussion_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + ] + }, + "number": { + "description": "The unique sequence number of a team discussion comment.", + "type": "integer", + "examples": [ + 42 + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-01-15T23:53:58Z" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + ] + }, + "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": [ + "author", + "body", + "body_html", + "body_version", + "created_at", + "last_edited_at", + "discussion_url", + "html_url", + "node_id", + "number", + "updated_at", + "url" + ] + }, + "examples": { + "default": { + "value": { + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Do you like pineapples?", + "body_html": "

Do you like pineapples?

", + "body_version": "e6907b24d9c93cc0c5024a7af5888116", + "created_at": "2018-01-15T23:53:58Z", + "last_edited_at": "2018-01-26T18:22:20Z", + "discussion_url": "https://api.github.com/teams/2403582/discussions/1", + "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", + "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", + "number": 1, + "updated_at": "2018-01-26T18:22:20Z", + "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", + "reactions": { + "url": "https://api.github.com/teams/2403582/discussions/1/reactions", + "total_count": 5, + "+1": 3, + "-1": 1, + "laugh": 0, + "confused": 0, + "heart": 1, + "hooray": 0, + "eyes": 1, + "rocket": 1 + } } } } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "discussion-comments" + } + }, + "delete": { + "summary": "Delete a discussion comment", + "description": "Deletes a comment on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "tags": [ + "teams" + ], + "operationId": "teams/delete-discussion-comment-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment" + }, + "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": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discussion_number", + "description": "The number that identifies the discussion.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "comment_number", + "description": "The number that identifies the comment.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "discussion-comments" + } + } + }, + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { + "get": { + "summary": "List reactions for a team discussion comment", + "description": "List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "tags": [ + "reactions" + ], + "operationId": "reactions/list-for-team-discussion-comment-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discussion_number", + "description": "The number that identifies the discussion.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "comment_number", + "description": "The number that identifies the comment.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "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.", + "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": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDg6UmVhY3Rpb24x" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "content": { + "description": "The reaction to use", + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "examples": [ + "heart" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-05-20T20:09:31Z" + ] + } }, - "status": { - "type": "string" - } + "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" + } + } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true + "category": "reactions", + "subcategory": "reactions" + } }, "post": { - "summary": "Create a project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "summary": "Create reaction for a team discussion comment", + "description": "Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ - "projects-classic" + "reactions" ], - "operationId": "projects-classic/create-column", + "operationId": "reactions/create-for-team-discussion-comment-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#create-a-project-column" + "url": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment" }, "parameters": [ { - "name": "project_id", - "description": "The unique identifier of the project.", + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discussion_number", + "description": "The number that identifies the discussion.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "comment_number", + "description": "The number that identifies the comment.", "in": "path", "required": true, "schema": { @@ -184203,24 +176065,31 @@ "content": { "application/json": { "schema": { + "type": "object", "properties": { - "name": { - "description": "Name of the project column", + "content": { "type": "string", - "examples": [ - "Remaining tasks" + "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" ] } }, "required": [ - "name" - ], - "type": "object" + "content" + ] }, "examples": { "default": { "value": { - "name": "Remaining tasks" + "content": "heart" } } } @@ -184228,704 +176097,627 @@ } }, "responses": { - "201": { - "description": "Response", + "200": { + "description": "Response when the reaction type has already been added to this team discussion comment", "content": { "application/json": { "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", + "title": "Reaction", + "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - }, - "cards_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367/cards" - ] - }, "id": { - "description": "The unique identifier of the project column", "type": "integer", "examples": [ - 42 + 1 ] }, "node_id": { "type": "string", "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" + "MDg6UmVhY3Rpb24x" ] }, - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } ] }, - "created_at": { + "content": { + "description": "The reaction to use", "type": "string", - "format": "date-time", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], "examples": [ - "2016-09-05T14:18:44Z" + "heart" ] }, - "updated_at": { + "created_at": { "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:22:28Z" + "2016-05-20T20:09:31Z" ] } }, "required": [ "id", "node_id", - "url", - "project_url", - "cards_url", - "name", - "created_at", - "updated_at" + "user", + "content", + "created_at" ] }, "examples": { "default": { "value": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "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" - } - } - } - } - } - }, - "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": 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" } } } } } }, - "401": { - "description": "Requires authentication", + "201": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Reaction", + "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + "id": { + "type": "integer", + "examples": [ + 1 + ] }, - "url": { - "type": "string" + "node_id": { + "type": "string", + "examples": [ + "MDg6UmVhY3Rpb24x" + ] }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/rate_limit": { - "get": { - "summary": "Get rate limit status for the authenticated user", - "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners).\"\n* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", - "tags": [ - "rate-limit" - ], - "operationId": "rate-limit/get", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user" - }, - "parameters": [], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Rate Limit Overview", - "description": "Rate Limit Overview", - "type": "object", - "properties": { - "resources": { - "type": "object", - "properties": { - "core": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "graphql": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "search": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "code_search": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "source_import": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] + "user": { + "anyOf": [ + { + "type": "null" }, - "integration_manifest": { - "title": "Rate Limit", + { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "limit": { - "type": "integer" + "name": { + "type": [ + "string", + "null" + ] }, - "remaining": { - "type": "integer" + "email": { + "type": [ + "string", + "null" + ] }, - "reset": { - "type": "integer" + "login": { + "type": "string", + "examples": [ + "octocat" + ] }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "code_scanning_upload": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] }, - "remaining": { - "type": "integer" + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] }, - "reset": { - "type": "integer" + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "actions_runner_registration": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] }, - "remaining": { - "type": "integer" + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] }, - "reset": { - "type": "integer" + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "scim": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] }, - "remaining": { - "type": "integer" + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] }, - "reset": { - "type": "integer" + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "dependency_snapshots": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] }, - "remaining": { - "type": "integer" + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] }, - "reset": { - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "dependency_sbom": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] }, - "remaining": { - "type": "integer" + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] }, - "reset": { - "type": "integer" + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "code_scanning_autofix": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "type": { + "type": "string", + "examples": [ + "User" + ] }, - "remaining": { - "type": "integer" + "site_admin": { + "type": "boolean" }, - "reset": { - "type": "integer" + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] }, - "used": { - "type": "integer" + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } }, "required": [ - "limit", - "remaining", - "reset", - "used" + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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": [ - "core", - "search" ] }, - "rate": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" + "content": { + "description": "The reaction to use", + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "examples": [ + "heart" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-05-20T20:09:31Z" ] } }, "required": [ - "rate", - "resources" + "id", + "node_id", + "user", + "content", + "created_at" ] }, "examples": { "default": { "value": { - "resources": { - "core": { - "limit": 5000, - "used": 1, - "remaining": 4999, - "reset": 1691591363 - }, - "search": { - "limit": 30, - "used": 12, - "remaining": 18, - "reset": 1691591091 - }, - "graphql": { - "limit": 5000, - "used": 7, - "remaining": 4993, - "reset": 1691593228 - }, - "integration_manifest": { - "limit": 5000, - "used": 1, - "remaining": 4999, - "reset": 1691594631 - }, - "source_import": { - "limit": 100, - "used": 1, - "remaining": 99, - "reset": 1691591091 - }, - "code_scanning_upload": { - "limit": 500, - "used": 1, - "remaining": 499, - "reset": 1691594631 - }, - "actions_runner_registration": { - "limit": 10000, - "used": 0, - "remaining": 10000, - "reset": 1691594631 - }, - "scim": { - "limit": 15000, - "used": 0, - "remaining": 15000, - "reset": 1691594631 - }, - "dependency_snapshots": { - "limit": 100, - "used": 0, - "remaining": 100, - "reset": 1691591091 - }, - "code_search": { - "limit": 10, - "used": 0, - "remaining": 10, - "reset": 1691591091 - }, - "code_scanning_autofix": { - "limit": 10, - "used": 0, - "remaining": 10, - "reset": 1691591091 - } + "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 }, - "rate": { - "limit": 5000, - "used": 1, - "remaining": 4999, - "reset": 1372700873 - } + "content": "heart", + "created_at": "2016-05-20T20:09:31Z" } } } } - }, - "headers": { - "X-RateLimit-Limit": { - "example": 5000, - "schema": { - "type": "integer" - } - }, - "X-RateLimit-Remaining": { - "example": 4999, - "schema": { - "type": "integer" - } - }, - "X-RateLimit-Reset": { - "example": 1590701888, - "schema": { - "type": "integer", - "format": "timestamp" - } - } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "reactions", + "subcategory": "reactions" + } + } + }, + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { + "delete": { + "summary": "Delete team discussion comment reaction", + "description": "> [!NOTE]\n> You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "tags": [ + "reactions" + ], + "operationId": "reactions/delete-for-team-discussion-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reactions/reactions#delete-team-discussion-comment-reaction" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" } }, - "304": { - "description": "Not modified" + { + "name": "team_slug", + "description": "The slug of the team name.", + "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": "discussion_number", + "description": "The number that identifies the discussion.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "comment_number", + "description": "The number that identifies the comment.", + "in": "path", + "required": true, + "schema": { + "type": "integer" } + }, + { + "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": "rate-limit", - "subcategory": "rate-limit" + "category": "reactions", + "subcategory": "reactions" } } }, - "/repos/{owner}/{repo}": { + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { "get": { - "summary": "Get a repository", - "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n> [!NOTE]\n> In order to see the `security_and_analysis` block for a repository 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).\"", + "summary": "List reactions for a team discussion", + "description": "List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ - "repos" + "reactions" ], - "operationId": "repos/get", + "operationId": "reactions/list-for-team-discussion-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/repos#get-a-repository" + "url": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion" }, "parameters": [ { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { @@ -184933,13 +176725,59 @@ } }, { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "name": "team_slug", + "description": "The slug of the team name.", "in": "path", "required": true, "schema": { "type": "string" } + }, + { + "name": "discussion_number", + "description": "The number that identifies the discussion.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "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.", + "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": { @@ -184948,4116 +176786,2603 @@ "content": { "application/json": { "schema": { - "title": "Full Repository", - "description": "Full Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + "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", + "examples": [ + 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", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" + "node_id": { + "type": "string", + "examples": [ + "MDg6UmVhY3Rpb24x" + ] }, - "examples": [ - "octocat", - "atom", - "electron", - "API" - ] - }, - "has_issues": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_discussions": { - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "type": "string", - "examples": [ - "public" - ] - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "content": { + "description": "The reaction to use", + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "examples": [ + "heart" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-05-20T20:09:31Z" + ] + } }, - "created_at": { - "type": "string", - "format": "date-time", + "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" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "reactions", + "subcategory": "reactions" + } + }, + "post": { + "summary": "Create reaction for a team discussion", + "description": "Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "tags": [ + "reactions" + ], + "operationId": "reactions/create-for-team-discussion-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discussion_number", + "description": "The number that identifies the discussion.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "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 team discussion.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + } + }, + "required": [ + "content" + ] + }, + "examples": { + "default": { + "value": { + "content": "heart" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "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", "examples": [ - "2011-01-26T19:01:12Z" + 1 ] }, - "updated_at": { + "node_id": { "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "allow_rebase_merge": { - "type": "boolean", "examples": [ - true + "MDg6UmVhY3Rpb24x" ] }, - "template_repository": { + "user": { "anyOf": [ { "type": "null" }, { - "title": "Repository", - "description": "A repository on GitHub.", + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 + "name": { + "type": [ + "string", + "null" ] }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "email": { + "type": [ + "string", + "null" ] }, - "name": { - "description": "The name of the repository.", + "login": { "type": "string", "examples": [ - "Team Environment" + "octocat" ] }, - "full_name": { - "type": "string", + "id": { + "type": "integer", + "format": "int64", "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" + 1 ] }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" ] }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { + "avatar_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat/Hello-World" + "https://github.com/images/error/octocat_happy.gif" ] }, - "description": { + "gravatar_id": { "type": [ "string", "null" ], "examples": [ - "This your first repo!" + "41d064eb2195891e12d0413f63227ea7" ] }, - "fork": { - "type": "boolean" - }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + "https://api.github.com/users/octocat" ] }, - "collaborators_url": { + "html_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + "https://github.com/octocat" ] }, - "comments_url": { + "followers_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + "https://api.github.com/users/octocat/followers" ] }, - "commits_url": { + "following_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "compare_url": { + "gists_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "contents_url": { + "starred_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "contributors_url": { + "subscriptions_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" + "https://api.github.com/users/octocat/subscriptions" ] }, - "deployments_url": { + "organizations_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" + "https://api.github.com/users/octocat/orgs" ] }, - "downloads_url": { + "repos_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" + "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "forks_url": { + "received_events_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + "https://api.github.com/users/octocat/received_events" ] }, - "git_refs_url": { + "type": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + "User" ] }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] + "site_admin": { + "type": "boolean" }, - "git_url": { + "starred_at": { "type": "string", "examples": [ - "git:github.com/octocat/Hello-World.git" + "\"2020-07-09T00:17:55Z\"" ] }, - "issue_comment_url": { + "user_view_type": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + "public" ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "content": { + "description": "The reaction to use", + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "examples": [ + "heart" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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": "Response", + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDg6UmVhY3Rpb24x" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" ] }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + "email": { + "type": [ + "string", + "null" ] }, - "keys_url": { + "login": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + "octocat" ] }, - "labels_url": { - "type": "string", + "id": { + "type": "integer", + "format": "int64", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + 1 ] }, - "languages_url": { + "node_id": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" + "MDQ6VXNlcjE=" ] }, - "merges_url": { + "avatar_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + "https://github.com/images/error/octocat_happy.gif" ] }, - "pulls_url": { - "type": "string", + "gravatar_id": { + "type": [ + "string", + "null" + ], "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + "41d064eb2195891e12d0413f63227ea7" ] }, - "releases_url": { + "url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + "https://api.github.com/users/octocat" ] }, - "ssh_url": { + "html_url": { "type": "string", + "format": "uri", "examples": [ - "git@github.com:octocat/Hello-World.git" + "https://github.com/octocat" ] }, - "stargazers_url": { + "followers_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" + "https://api.github.com/users/octocat/followers" ] }, - "statuses_url": { + "following_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "subscribers_url": { + "gists_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "subscription_url": { + "starred_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "tags_url": { + "subscriptions_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" + "https://api.github.com/users/octocat/subscriptions" ] }, - "teams_url": { + "organizations_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + "https://api.github.com/users/octocat/orgs" ] }, - "clone_url": { + "repos_url": { "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], "format": "uri", "examples": [ - "git:git.example.com/octocat/Hello-World" + "https://api.github.com/users/octocat/repos" ] }, - "hooks_url": { + "events_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "svn_url": { + "received_events_url": { "type": "string", "format": "uri", "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 + "https://api.github.com/users/octocat/received_events" ] }, - "default_branch": { - "description": "The default branch of the repository.", + "type": { "type": "string", "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true + "User" ] }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, + "site_admin": { "type": "boolean" }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "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": { + "starred_at": { "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", "examples": [ - true + "\"2020-07-09T00:17:55Z\"" ] }, - "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": { + "user_view_type": { "type": "string", "examples": [ - "\"2020-07-09T00:17:42Z\"" + "public" ] - }, - "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", + "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", - "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" + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] } ] }, - "temp_clone_token": { - "type": [ - "string", - "null" - ] - }, - "allow_squash_merge": { - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "type": "boolean", - "examples": [ - false - ] - }, - "allow_merge_commit": { - "type": "boolean", + "content": { + "description": "The reaction to use", + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], "examples": [ - true + "heart" ] }, - "allow_update_branch": { - "type": "boolean", + "created_at": { + "type": "string", + "format": "date-time", "examples": [ - true - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "examples": [ - false + "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" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "reactions", + "subcategory": "reactions" + } + } + }, + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { + "delete": { + "summary": "Delete team discussion reaction", + "description": "> [!NOTE]\n> You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "tags": [ + "reactions" + ], + "operationId": "reactions/delete-for-team-discussion", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reactions/reactions#delete-team-discussion-reaction" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discussion_number", + "description": "The number that identifies the discussion.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "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" + } + } + }, + "/orgs/{org}/teams/{team_slug}/invitations": { + "get": { + "summary": "List pending team invitations", + "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`.", + "tags": [ + "teams" + ], + "operationId": "teams/list-pending-invitations-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/members#list-pending-team-invitations" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "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": "Organization Invitation", + "description": "Organization Invitation", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "role": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "failed_at": { + "type": [ + "string", + "null" + ] + }, + "failed_reason": { + "type": [ + "string", + "null" + ] + }, + "inviter": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "team_count": { + "type": "integer" + }, + "node_id": { + "type": "string", + "examples": [ + "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" + ] + }, + "invitation_teams_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/organizations/16/invitations/1/teams\"" + ] + }, + "invitation_source": { + "type": "string", + "examples": [ + "\"member\"" + ] + } }, - "squash_merge_commit_title": { + "required": [ + "id", + "login", + "email", + "role", + "created_at", + "inviter", + "team_count", + "invitation_teams_url", + "node_id" + ] + } + }, + "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", + "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 + }, + "team_count": 2, + "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams", + "invitation_source": "member" + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "members" + } + } + }, + "/orgs/{org}/teams/{team_slug}/members": { + "get": { + "summary": "List team members", + "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.", + "tags": [ + "teams" + ], + "operationId": "teams/list-members-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/members#list-team-members" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "role", + "description": "Filters members returned by their role in the team.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "member", + "maintainer", + "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", + "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": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "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 + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "members" + } + } + }, + "/orgs/{org}/teams/{team_slug}/memberships/{username}": { + "get": { + "summary": "Get team membership for a user", + "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team).", + "tags": [ + "teams" + ], + "operationId": "teams/get-membership-for-user-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/members#get-team-membership-for-a-user" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "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": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Team Membership", + "description": "Team Membership", + "type": "object", + "properties": { + "url": { "type": "string", + "format": "uri" + }, + "role": { + "description": "The role of the user in the team.", "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" + "member", + "maintainer" ], - "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).", + "default": "member", + "type": "string", "examples": [ - "PR_TITLE" + "member" ] }, - "squash_merge_commit_message": { + "state": { + "description": "The state of the user's membership in the team.", "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.", - "examples": [ - "PR_BODY" + "active", + "pending" ] - }, - "merge_commit_title": { + } + }, + "required": [ + "role", + "state", + "url" + ] + }, + "examples": { + "response-if-user-is-a-team-maintainer": { + "summary": "Response if user is a team maintainer", + "value": { + "url": "https://api.github.com/teams/1/memberships/octocat", + "role": "maintainer", + "state": "active" + } + } + } + } + } + }, + "404": { + "description": "if user has no team membership" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "members" + } + }, + "put": { + "summary": "Add or update team membership for a user", + "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "tags": [ + "teams" + ], + "operationId": "teams/add-or-update-membership-for-user-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "role": { + "type": "string", + "description": "The role that this user should have in the team.", + "enum": [ + "member", + "maintainer" + ], + "default": "member" + } + } + }, + "examples": { + "default": { + "summary": "Add or update team membership for an organization member", + "value": { + "role": "maintainer" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Team Membership", + "description": "Team Membership", + "type": "object", + "properties": { + "url": { "type": "string", + "format": "uri" + }, + "role": { + "description": "The role of the user in the team.", "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" + "member", + "maintainer" ], - "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).", + "default": "member", + "type": "string", "examples": [ - "PR_TITLE" + "member" ] }, - "merge_commit_message": { + "state": { + "description": "The state of the user's membership in the team.", "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.", - "examples": [ - "PR_BODY" + "active", + "pending" ] + } + }, + "required": [ + "role", + "state", + "url" + ] + }, + "examples": { + "response-if-users-membership-with-team-is-now-pending": { + "summary": "Response if user's membership with team is now pending", + "value": { + "url": "https://api.github.com/teams/1/memberships/octocat", + "role": "member", + "state": "pending" + } + } + } + } + } + }, + "403": { + "description": "Forbidden if team synchronization is set up" + }, + "422": { + "description": "Unprocessable Entity if you attempt to add an organization to a team" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "members" + } + }, + "delete": { + "summary": "Remove team membership for a user", + "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "tags": [ + "teams" + ], + "operationId": "teams/remove-membership-for-user-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "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 if team synchronization is set up" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "members" + } + } + }, + "/orgs/{org}/teams/{team_slug}/projects": { + "get": { + "summary": "List team projects", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "tags": [ + "teams" + ], + "operationId": "teams/list-projects-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/teams#list-team-projects" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "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": "Team Project", + "description": "A team's access to a project.", + "type": "object", + "properties": { + "owner_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "columns_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "body": { + "type": [ + "string", + "null" + ] + }, + "number": { + "type": "integer" + }, + "state": { + "type": "string" + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "organization_permission": { + "description": "The organization permission for this project. Only present when owner is an organization.", + "type": "string" + }, + "private": { + "description": "Whether the project is private or not. Only present when owner is an organization.", + "type": "boolean" + }, + "permissions": { + "type": "object", + "properties": { + "read": { + "type": "boolean" + }, + "write": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "read", + "write", + "admin" + ] + } }, - "allow_forking": { - "type": "boolean", - "examples": [ - true - ] + "required": [ + "owner_url", + "url", + "html_url", + "columns_url", + "id", + "node_id", + "name", + "body", + "number", + "state", + "creator", + "created_at", + "updated_at", + "permissions" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "owner_url": "https://api.github.com/orgs/octocat", + "url": "https://api.github.com/projects/1002605", + "html_url": "https://github.com/orgs/api-playground/projects/1", + "columns_url": "https://api.github.com/projects/1002605/columns", + "id": 1002605, + "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", + "name": "Organization Roadmap", + "body": "High-level roadmap for the upcoming year.", + "number": 1, + "state": "open", + "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 + }, + "created_at": "2011-04-11T20:09:31Z", + "updated_at": "2014-03-04T18:58:10Z", + "organization_permission": "write", + "private": false, + "permissions": { + "read": true, + "write": true, + "admin": false + } + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "teams", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true + } + }, + "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { + "get": { + "summary": "Check team permissions for a project", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "tags": [ + "teams" + ], + "operationId": "teams/check-permissions-for-project-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "project_id", + "description": "The unique identifier of the project.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Team Project", + "description": "A team's access to a project.", + "type": "object", + "properties": { + "owner_url": { + "type": "string" }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] + "url": { + "type": "string" }, - "subscribers_count": { - "type": "integer", - "examples": [ - 42 - ] + "html_url": { + "type": "string" }, - "network_count": { - "type": "integer", - "examples": [ - 0 - ] + "columns_url": { + "type": "string" }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] + "id": { + "type": "integer" }, - "organization": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "body": { + "type": [ + "string", + "null" ] }, - "parent": { - "title": "Repository", - "description": "A repository on GitHub.", + "number": { + "type": "integer" + }, + "state": { + "type": "string" + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, "id": { - "description": "Unique identifier of the repository", "type": "integer", "format": "int64", "examples": [ - 42 + 1 ] }, "node_id": { "type": "string", "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "MDQ6VXNlcjE=" ] }, - "name": { - "description": "The name of the repository.", + "avatar_url": { "type": "string", + "format": "uri", "examples": [ - "Team Environment" + "https://github.com/images/error/octocat_happy.gif" ] }, - "full_name": { + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { "type": "string", + "format": "uri", "examples": [ - "octocat/Hello-World" + "https://api.github.com/users/octocat" ] }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" ] }, - "forks": { - "type": "integer" + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { + "gists_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "contents_url": { + "starred_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "contributors_url": { + "subscriptions_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" + "https://api.github.com/users/octocat/subscriptions" ] }, - "deployments_url": { + "organizations_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" + "https://api.github.com/users/octocat/orgs" ] }, - "downloads_url": { + "repos_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" + "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "svn_url": { + "received_events_url": { "type": "string", "format": "uri", "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false + "https://api.github.com/users/octocat/received_events" ] }, - "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": { "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", "examples": [ - true + "User" ] }, - "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, + "site_admin": { "type": "boolean" }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, "starred_at": { "type": "string", "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] - }, - "source": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true + "\"2020-07-09T00:17:55Z\"" ] }, - "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": { + "user_view_type": { "type": "string", "examples": [ - "\"2020-07-09T00:17:42Z\"" + "public" ] - }, - "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", + "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", - "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" + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, - "forks": { - "type": "integer" - }, - "master_branch": { + "created_at": { "type": "string" }, - "open_issues": { - "type": "integer" + "updated_at": { + "type": "string" }, - "watchers": { - "type": "integer" + "organization_permission": { + "description": "The organization permission for this project. Only present when owner is an organization.", + "type": "string" }, - "anonymous_access_enabled": { - "description": "Whether anonymous git access is allowed.", - "default": true, + "private": { + "description": "Whether the project is private or not. Only present when owner is an organization.", "type": "boolean" }, - "code_of_conduct": { - "title": "Code Of Conduct Simple", - "description": "Code of Conduct Simple", + "permissions": { "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/github/docs/community/code_of_conduct" - ] - }, - "key": { - "type": "string", - "examples": [ - "citizen_code_of_conduct" - ] + "read": { + "type": "boolean" }, - "name": { - "type": "string", - "examples": [ - "Citizen Code of Conduct" - ] + "write": { + "type": "boolean" }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md" - ] + "admin": { + "type": "boolean" } }, "required": [ - "url", - "key", - "name", - "html_url" + "read", + "write", + "admin" ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "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", + "owner_url", + "url", "html_url", + "columns_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_issues", - "has_projects", - "has_wiki", - "has_pages", - "has_discussions", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", + "body", + "number", + "state", + "creator", "created_at", "updated_at", - "network_count", - "subscribers_count" + "permissions" ] }, "examples": { - "default-response": { - "summary": "Default response", + "default": { "value": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { + "owner_url": "https://api.github.com/orgs/octocat", + "url": "https://api.github.com/projects/1002605", + "html_url": "https://github.com/orgs/api-playground/projects/1", + "columns_url": "https://api.github.com/projects/1002605/columns", + "id": 1002605, + "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", + "name": "Organization Roadmap", + "body": "High-level roadmap for the upcoming year.", + "number": 1, + "state": "open", + "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -189077,367 +179402,1120 @@ "type": "User", "site_admin": false }, + "created_at": "2011-04-11T20:09:31Z", + "updated_at": "2014-03-04T18:58:10Z", + "organization_permission": "write", "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", - "forks_count": 9, - "forks": 9, - "stargazers_count": 80, - "watchers_count": 80, - "watchers": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "open_issues": 0, - "is_template": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "has_discussions": false, - "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": { - "pull": true, - "push": false, + "read": true, + "write": true, "admin": false - }, - "allow_rebase_merge": true, - "template_repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World-Template", - "full_name": "octocat/Hello-World-Template", - "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-Template", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World-Template", - "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World-Template.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World-Template.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World-Template.git", - "mirror_url": "git:git.example.com/octocat/Hello-World-Template", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World-Template", - "homepage": "https://github.com", - "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" + } + } + } + } + } + } + }, + "404": { + "description": "Not Found if project is not managed by this team" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "teams", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true + }, + "put": { + "summary": "Add or update team project permissions", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "tags": [ + "teams" + ], + "operationId": "teams/add-or-update-project-permissions-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "project_id", + "description": "The unique identifier of the project.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": [ + "object", + "null" + ], + "properties": { + "permission": { + "type": "string", + "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "enum": [ + "read", + "write", + "admin" + ] + } + } + }, + "examples": { + "default": { + "summary": "Updates the permissions for the team to write for the project", + "value": { + "permission": "write" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden if the project is not owned by the organization", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + }, + "examples": { + "response-if-the-project-is-not-owned-by-the-organization": { + "value": { + "message": "Must have admin rights to Repository.", + "documentation_url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "teams", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true + }, + "delete": { + "summary": "Remove a project from a team", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "tags": [ + "teams" + ], + "operationId": "teams/remove-project-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "project_id", + "description": "The unique identifier of the project.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "teams", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true + } + }, + "/orgs/{org}/teams/{team_slug}/repos": { + "get": { + "summary": "List team repositories", + "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", + "tags": [ + "teams" + ], + "operationId": "teams/list-repos-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/teams#list-team-repositories" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "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": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - "topics": [ - "octocat", - "atom", - "electron", - "api" + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" ], - "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 + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "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", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# 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", + "null" + ], + "format": "uri" + } }, - "allow_rebase_merge": true, - "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 + "required": [ + "url", + "html_url", + "key", + "name" + ] }, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "allow_forking": true, - "subscribers_count": 42, - "network_count": 0, "license": { - "key": "mit", - "name": "MIT License", - "spdx_id": "MIT", - "url": "https://api.github.com/licenses/mit", - "node_id": "MDc6TGljZW5zZW1pdA==" + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } }, - "organization": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "Organization", - "site_admin": false + "forks": { + "type": "integer", + "examples": [ + 0 + ] }, - "parent": { - "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" + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" ], - "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, - "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://api.github.com/licenses/mit" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 + "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" + ] + } + } + } + } }, - "source": { + "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": [ + { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", @@ -189509,13 +180587,14 @@ "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, + "is_template": false, "topics": [ "octocat", "atom", @@ -189527,6 +180606,7 @@ "has_wiki": true, "has_pages": false, "has_downloads": true, + "has_discussions": false, "archived": false, "disabled": false, "visibility": "public", @@ -189538,25 +180618,6 @@ "push": false, "pull": true }, - "allow_rebase_merge": true, - "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://api.github.com/licenses/mit" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1, "security_and_analysis": { "advanced_security": { "status": "enabled" @@ -189572,86 +180633,16 @@ } } } - } - } - } - } - } - }, - "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" - } + ] } } } - } - }, - "301": { - "description": "Moved permanently", - "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" } } } @@ -189660,22 +180651,42 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "repos" + "category": "teams", + "subcategory": "teams" } - }, - "patch": { - "summary": "Update a repository", - "description": "**Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/repos/repos#replace-all-repository-topics) endpoint.", + } + }, + "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": { + "get": { + "summary": "Check team permissions for a repository", + "description": "Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header.\n\nIf a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.\n\nIf the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", "tags": [ - "repos" + "teams" ], - "operationId": "repos/update", + "operationId": "teams/check-permissions-for-repo-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/repos#update-a-repository" + "url": "https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository" }, "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.", @@ -189695,249 +180706,21 @@ } } ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository." - }, - "description": { - "type": "string", - "description": "A short description of the repository." - }, - "homepage": { - "type": "string", - "description": "A URL with more information about the repository." - }, - "private": { - "type": "boolean", - "description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", - "default": false - }, - "visibility": { - "type": "string", - "description": "The visibility of the repository.", - "enum": [ - "public", - "private" - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "description": "Specify which security and analysis features to enable or disable for the repository.\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\nFor example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request:\n`{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }`.\n\nYou can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request.", - "properties": { - "advanced_security": { - "type": "object", - "description": "Use the `status` property to enable or disable GitHub Advanced Security for this repository.\nFor more information, see \"[About GitHub Advanced\nSecurity](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.", - "properties": { - "status": { - "type": "string", - "description": "Can be `enabled` or `disabled`." - } - } - }, - "code_security": { - "type": "object", - "description": "Use the `status` property to enable or disable GitHub Code Security for this repository.", - "properties": { - "status": { - "type": "string", - "description": "Can be `enabled` or `disabled`." - } - } - }, - "secret_scanning": { - "type": "object", - "description": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", - "properties": { - "status": { - "type": "string", - "description": "Can be `enabled` or `disabled`." - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "description": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"", - "properties": { - "status": { - "type": "string", - "description": "Can be `enabled` or `disabled`." - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "description": "Use the `status` property to enable or disable secret scanning AI detection for this repository. For more information, see \"[Responsible detection of generic secrets with AI](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/generic-secret-detection/responsible-ai-generic-secrets).\"", - "properties": { - "status": { - "type": "string", - "description": "Can be `enabled` or `disabled`." - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "description": "Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. For more information, see \"[Supported secret scanning patterns](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"", - "properties": { - "status": { - "type": "string", - "description": "Can be `enabled` or `disabled`." - } - } - } - } - }, - "has_issues": { - "type": "boolean", - "description": "Either `true` to enable issues for this repository or `false` to disable them.", - "default": true - }, - "has_projects": { - "type": "boolean", - "description": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", - "default": true - }, - "has_wiki": { - "type": "boolean", - "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", - "default": true - }, - "is_template": { - "type": "boolean", - "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", - "default": false - }, - "default_branch": { - "type": "string", - "description": "Updates the default branch for this repository." - }, - "allow_squash_merge": { - "type": "boolean", - "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", - "default": true - }, - "allow_merge_commit": { - "type": "boolean", - "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", - "default": true - }, - "allow_rebase_merge": { - "type": "boolean", - "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", - "default": true - }, - "allow_auto_merge": { - "type": "boolean", - "description": "Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge.", - "default": false - }, - "delete_branch_on_merge": { - "type": "boolean", - "description": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", - "default": false - }, - "allow_update_branch": { - "type": "boolean", - "description": "Either `true` to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise.", - "default": false - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **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": "Required when using `squash_merge_commit_message`.\n\nThe 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": "Required when using `merge_commit_message`.\n\nThe 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." - }, - "archived": { - "type": "boolean", - "description": "Whether to archive this repository. `false` will unarchive a previously archived repository.", - "default": false - }, - "allow_forking": { - "type": "boolean", - "description": "Either `true` to allow private forks, or `false` to prevent private forks.", - "default": false - }, - "web_commit_signoff_required": { - "type": "boolean", - "description": "Either `true` to require contributors to sign off on web-based commits, or `false` to not require contributors to sign off on web-based commits.", - "default": false - } - } - }, - "examples": { - "default": { - "value": { - "name": "Hello-World", - "description": "This is your first repository", - "homepage": "https://github.com", - "private": true, - "has_issues": true, - "has_projects": true, - "has_wiki": true - } - } - } - } - } - }, "responses": { "200": { - "description": "Response", + "description": "Alternative response with repository permissions", "content": { "application/json": { "schema": { - "title": "Full Repository", - "description": "Full Repository", + "title": "Team Repository", + "description": "A team's access to a repository.", "type": "object", "properties": { "id": { + "description": "Unique identifier of the repository", "type": "integer", - "format": "int64", "examples": [ - 1296269 + 42 ] }, "node_id": { @@ -189947,9 +180730,10 @@ ] }, "name": { + "description": "The name of the repository.", "type": "string", "examples": [ - "Hello-World" + "Team Environment" ] }, "full_name": { @@ -189958,302 +180742,407 @@ "octocat/Hello-World" ] }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "license": { + "anyOf": [ + { + "type": "null" }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" }, - "type": { - "type": "string", - "examples": [ - "User" - ] + "pull": { + "type": "boolean" }, - "site_admin": { + "triage": { "type": "boolean" }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "push": { + "type": "boolean" }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] + "maintain": { + "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" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + "admin", + "pull", + "push" ] }, - "git_refs_url": { + "role_name": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + "admin" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { @@ -190454,13 +181343,13 @@ ] }, "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "type": "integer", "examples": [ 108 ] }, "default_branch": { + "description": "The default branch of the repository.", "type": "string", "examples": [ "master" @@ -190473,6 +181362,8 @@ ] }, "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, "type": "boolean", "examples": [ true @@ -190482,27 +181373,27 @@ "type": "array", "items": { "type": "string" - }, - "examples": [ - "octocat", - "atom", - "electron", - "API" - ] + } }, "has_issues": { + "description": "Whether issues are enabled.", + "default": true, "type": "boolean", "examples": [ true ] }, "has_projects": { + "description": "Whether projects are enabled.", + "default": true, "type": "boolean", "examples": [ true ] }, "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, "type": "boolean", "examples": [ true @@ -190512,18 +181403,16 @@ "type": "boolean" }, "has_downloads": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_discussions": { + "description": "Whether downloads are enabled.", + "default": true, "type": "boolean", "examples": [ true ] }, "archived": { + "description": "Whether the repository is archived.", + "default": false, "type": "boolean" }, "disabled": { @@ -190532,1491 +181421,3307 @@ }, "visibility": { "description": "The repository visibility: public, private, or internal.", - "type": "string", - "examples": [ - "public" - ] + "default": "public", + "type": "string" }, "pushed_at": { - "type": "string", + "type": [ + "string", + "null" + ], "format": "date-time", "examples": [ "2011-01-26T19:06:43Z" ] }, "created_at": { - "type": "string", + "type": [ + "string", + "null" + ], "format": "date-time", "examples": [ "2011-01-26T19:01:12Z" ] }, "updated_at": { - "type": "string", + "type": [ + "string", + "null" + ], "format": "date-time", "examples": [ "2011-01-26T19:14:43Z" ] }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true ] }, - "allow_rebase_merge": { + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, "type": "boolean", "examples": [ true ] }, - "template_repository": { + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "examples": { + "alternative-response-with-repository-permissions": { + "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}", + "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": false, + "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, + "maintain": false, + "push": false, + "triage": false, + "pull": true + }, + "role_name": "read", + "allow_rebase_merge": true, + "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://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + } + } + } + } + }, + "204": { + "description": "Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header." + }, + "404": { + "description": "Not Found if team does not have permission for the repository" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "teams" + } + }, + "put": { + "summary": "Add or update team repository permissions", + "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", + "tags": [ + "teams" + ], + "operationId": "teams/add-or-update-repo-permissions-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "permission": { + "type": "string", + "description": "The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository." + } + } + }, + "examples": { + "default": { + "summary": "Adding a team to an organization repository with the write role", + "value": { + "permission": "push" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "teams" + } + }, + "delete": { + "summary": "Remove a repository from a team", + "description": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", + "tags": [ + "teams" + ], + "operationId": "teams/remove-repo-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "teams" + } + } + }, + "/orgs/{org}/teams/{team_slug}/teams": { + "get": { + "summary": "List child teams", + "description": "Lists the child teams of the team specified by `{team_slug}`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`.", + "tags": [ + "teams" + ], + "operationId": "teams/list-child-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/teams#list-child-teams" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "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": "if child teams exist", + "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", + "null" + ] + }, + "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", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "examples": { + "response-if-child-teams-exist": { + "value": [ + { + "id": 2, + "node_id": "MDQ6VGVhbTI=", + "url": "https://api.github.com/teams/2", + "name": "Original Roster", + "slug": "original-roster", + "description": "Started it all.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/2/members{/member}", + "repositories_url": "https://api.github.com/teams/2/repos", + "parent": { + "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" + }, + "html_url": "https://github.com/orgs/rails/teams/core" + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "teams" + } + } + }, + "/orgs/{org}/{security_product}/{enablement}": { + "post": { + "summary": "Enable or disable a security feature for an organization", + "description": "> [!WARNING]\n> **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/).\n\nEnables or disables the specified security feature for all eligible repositories in an organization. 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 organization owner or be member of a team with the security manager role to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/enable-or-disable-security-product-on-all-org-repos", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "security_product", + "in": "path", + "description": "The security feature to enable or disable.", + "required": true, + "schema": { + "type": "string", + "enum": [ + "dependency_graph", + "dependabot_alerts", + "dependabot_security_updates", + "advanced_security", + "code_scanning_default_setup", + "secret_scanning", + "secret_scanning_push_protection" + ] + } + }, + { + "name": "enablement", + "in": "path", + "description": "The action to take.\n\n`enable_all` means to enable the specified security feature for all repositories in the organization.\n`disable_all` means to disable the specified security feature for all repositories in the organization.", + "required": true, + "schema": { + "type": "string", + "enum": [ + "enable_all", + "disable_all" + ] + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "query_suite": { + "description": "CodeQL query suite to be used. If you specify the `query_suite` parameter, the default setup will be configured with this query suite only on all repositories that didn't have default setup already configured. It will not change the query suite on repositories that already have default setup configured.\nIf you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied.", + "type": "string", + "enum": [ + "default", + "extended" + ] + } + } + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "responses": { + "204": { + "description": "Action started" + }, + "422": { + "description": "The action could not be taken due to an in progress enablement, or a policy is preventing enablement" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "orgs", + "deprecationDate": "2024-07-22", + "removalDate": "2025-07-22" + }, + "deprecated": true + } + }, + "/projects/columns/cards/{card_id}": { + "get": { + "summary": "Get a project card", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "tags": [ + "projects-classic" + ], + "operationId": "projects-classic/get-card", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects-classic/cards#get-a-project-card" + }, + "parameters": [ + { + "name": "card_id", + "description": "The unique identifier of the card.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Project Card", + "description": "Project cards represent a scope of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/cards/1478" + ] + }, + "id": { + "description": "The project card's ID", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOlByb2plY3RDYXJkMTQ3OA==" + ] + }, + "note": { + "type": [ + "string", + "null" + ], + "examples": [ + "Add payload for delete Project column" + ] + }, + "creator": { "anyOf": [ { "type": "null" }, { - "title": "Repository", - "description": "A repository on GitHub.", + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 + "name": { + "type": [ + "string", + "null" ] }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "email": { + "type": [ + "string", + "null" ] }, - "name": { - "description": "The name of the repository.", + "login": { "type": "string", "examples": [ - "Team Environment" + "octocat" ] }, - "full_name": { - "type": "string", + "id": { + "type": "integer", + "format": "int64", "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" + 1 ] }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" ] }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { + "avatar_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat/Hello-World" + "https://github.com/images/error/octocat_happy.gif" ] }, - "description": { + "gravatar_id": { "type": [ "string", "null" ], "examples": [ - "This your first repo!" + "41d064eb2195891e12d0413f63227ea7" ] }, - "fork": { - "type": "boolean" - }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World" + "https://api.github.com/users/octocat" ] }, - "archive_url": { + "html_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + "https://github.com/octocat" ] }, - "assignees_url": { + "followers_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + "https://api.github.com/users/octocat/followers" ] }, - "blobs_url": { + "following_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "branches_url": { + "gists_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "collaborators_url": { + "starred_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "comments_url": { + "subscriptions_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + "https://api.github.com/users/octocat/subscriptions" ] }, - "commits_url": { + "organizations_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "https://api.github.com/users/octocat/orgs" ] }, - "compare_url": { + "repos_url": { "type": "string", + "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "https://api.github.com/users/octocat/repos" ] }, - "contents_url": { + "events_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "contributors_url": { + "received_events_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" + "https://api.github.com/users/octocat/received_events" ] }, - "deployments_url": { + "type": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" + "User" ] }, - "downloads_url": { + "site_admin": { + "type": "boolean" + }, + "starred_at": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" + "\"2020-07-09T00:17:55Z\"" ] }, - "events_url": { + "user_view_type": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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", + "examples": [ + "2016-09-05T14:21:06Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:20:22Z" + ] + }, + "archived": { + "description": "Whether or not the card is archived", + "type": "boolean", + "examples": [ + false + ] + }, + "column_name": { + "type": "string" + }, + "project_id": { + "type": "string" + }, + "column_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" + ] + }, + "content_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test/issues/3" + ] + }, + "project_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/120" + ] + } + }, + "required": [ + "id", + "node_id", + "note", + "url", + "column_url", + "project_url", + "creator", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "url": "https://api.github.com/projects/columns/cards/1478", + "id": 1478, + "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", + "note": "Add payload for delete Project column", + "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 + }, + "created_at": "2016-09-05T14:21:06Z", + "updated_at": "2016-09-05T14:20:22Z", + "archived": false, + "column_url": "https://api.github.com/projects/columns/367", + "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", + "project_url": "https://api.github.com/projects/120" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "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" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/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": "projects-classic", + "subcategory": "cards", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true + }, + "patch": { + "summary": "Update an existing project card", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "tags": [ + "projects-classic" + ], + "operationId": "projects-classic/update-card", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects-classic/cards#update-an-existing-project-card" + }, + "parameters": [ + { + "name": "card_id", + "description": "The unique identifier of the card.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "note": { + "description": "The project card's note", + "type": [ + "string", + "null" + ], + "examples": [ + "Update all gems" + ] + }, + "archived": { + "description": "Whether or not the card is archived", + "type": "boolean", + "examples": [ + false + ] + } + } + }, + "examples": { + "default": { + "summary": "Change the note on the card", + "value": { + "note": "Add payload for delete Project column" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Project Card", + "description": "Project cards represent a scope of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/cards/1478" + ] + }, + "id": { + "description": "The project card's ID", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOlByb2plY3RDYXJkMTQ3OA==" + ] + }, + "note": { + "type": [ + "string", + "null" + ], + "examples": [ + "Add payload for delete Project column" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" ] }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" + "email": { + "type": [ + "string", + "null" ] }, - "git_commits_url": { + "login": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + "octocat" ] }, - "git_refs_url": { - "type": "string", + "id": { + "type": "integer", + "format": "int64", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + 1 ] }, - "git_tags_url": { + "node_id": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + "MDQ6VXNlcjE=" ] }, - "git_url": { + "avatar_url": { "type": "string", + "format": "uri", "examples": [ - "git:github.com/octocat/Hello-World.git" + "https://github.com/images/error/octocat_happy.gif" ] }, - "issue_comment_url": { - "type": "string", + "gravatar_id": { + "type": [ + "string", + "null" + ], "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + "41d064eb2195891e12d0413f63227ea7" ] }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { + "url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" + "https://api.github.com/users/octocat" ] }, - "merges_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" + "https://github.com/octocat" ] }, - "stargazers_url": { + "followers_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" + "https://api.github.com/users/octocat/followers" ] }, - "statuses_url": { + "following_url": { "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "subscribers_url": { + "gists_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "subscription_url": { + "starred_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "tags_url": { + "subscriptions_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" + "https://api.github.com/users/octocat/subscriptions" ] }, - "teams_url": { + "organizations_url": { "type": "string", "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + "https://api.github.com/users/octocat/orgs" ] }, - "clone_url": { + "repos_url": { "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], "format": "uri", "examples": [ - "git:git.example.com/octocat/Hello-World" + "https://api.github.com/users/octocat/repos" ] }, - "hooks_url": { + "events_url": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "svn_url": { + "received_events_url": { "type": "string", "format": "uri", "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 + "https://api.github.com/users/octocat/received_events" ] }, - "default_branch": { - "description": "The default branch of the repository.", + "type": { "type": "string", "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true + "User" ] }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, + "site_admin": { "type": "boolean" }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "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": { + "starred_at": { "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", "examples": [ - true + "\"2020-07-09T00:17:55Z\"" ] }, - "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": { + "user_view_type": { "type": "string", "examples": [ - "\"2020-07-09T00:17:42Z\"" + "public" ] - }, - "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", + "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", - "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" + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] } ] }, - "temp_clone_token": { - "type": [ - "string", - "null" + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:21:06Z" ] }, - "allow_squash_merge": { - "type": "boolean", + "updated_at": { + "type": "string", + "format": "date-time", "examples": [ - true + "2016-09-05T14:20:22Z" ] }, - "allow_auto_merge": { + "archived": { + "description": "Whether or not the card is archived", "type": "boolean", "examples": [ false ] }, - "delete_branch_on_merge": { - "type": "boolean", + "column_name": { + "type": "string" + }, + "project_id": { + "type": "string" + }, + "column_url": { + "type": "string", + "format": "uri", "examples": [ - false + "https://api.github.com/projects/columns/367" ] }, - "allow_merge_commit": { - "type": "boolean", + "content_url": { + "type": "string", + "format": "uri", "examples": [ - true + "https://api.github.com/repos/api-playground/projects-test/issues/3" ] }, - "allow_update_branch": { - "type": "boolean", + "project_url": { + "type": "string", + "format": "uri", "examples": [ - true + "https://api.github.com/projects/120" ] + } + }, + "required": [ + "id", + "node_id", + "note", + "url", + "column_url", + "project_url", + "creator", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "url": "https://api.github.com/projects/columns/cards/1478", + "id": 1478, + "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", + "note": "Add payload for delete Project column", + "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 + }, + "created_at": "2016-09-05T14:21:06Z", + "updated_at": "2016-09-05T14:20:22Z", + "archived": false, + "column_url": "https://api.github.com/projects/columns/367", + "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", + "project_url": "https://api.github.com/projects/120" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "use_squash_pr_title_as_default": { - "type": "boolean", + "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" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/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": "projects-classic", + "subcategory": "cards", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true + }, + "delete": { + "summary": "Delete a project card", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "tags": [ + "projects-classic" + ], + "operationId": "projects-classic/delete-card", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects-classic/cards#delete-a-project-card" + }, + "parameters": [ + { + "name": "card_id", + "description": "The unique identifier of the card.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "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" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/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": "projects-classic", + "subcategory": "cards", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true + } + }, + "/projects/columns/cards/{card_id}/moves": { + "post": { + "summary": "Move a project card", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "tags": [ + "projects-classic" + ], + "operationId": "projects-classic/move-card", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects-classic/cards#move-a-project-card" + }, + "parameters": [ + { + "name": "card_id", + "description": "The unique identifier of the card.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "position": { + "description": "The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card.", + "type": "string", + "pattern": "^(?:top|bottom|after:\\d+)$", + "examples": [ + "bottom" + ] + }, + "column_id": { + "description": "The unique identifier of the column the card should be moved to", + "type": "integer", + "examples": [ + 42 + ] + } + }, + "required": [ + "position" + ], + "type": "object" + }, + "examples": { + "default": { + "summary": "Move the card to the bottom of the column", + "value": { + "column_id": 42, + "position": "bottom" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": {}, + "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "resource": { + "type": "string" + }, + "field": { + "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" + } + } + } + } + } + }, + "503": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects-classic", + "subcategory": "cards", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true + } + }, + "/projects/columns/{column_id}": { + "get": { + "summary": "Get a project column", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "tags": [ + "projects-classic" + ], + "operationId": "projects-classic/get-column", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects-classic/columns#get-a-project-column" + }, + "parameters": [ + { + "name": "column_id", + "description": "The unique identifier of the column.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Project Column", + "description": "Project columns contain cards of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", "examples": [ - false + "https://api.github.com/projects/columns/367" ] }, - "squash_merge_commit_title": { + "project_url": { "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).", + "format": "uri", "examples": [ - "PR_TITLE" + "https://api.github.com/projects/120" ] }, - "squash_merge_commit_message": { + "cards_url": { "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.", + "format": "uri", "examples": [ - "PR_BODY" + "https://api.github.com/projects/columns/367/cards" ] }, - "merge_commit_title": { + "id": { + "description": "The unique identifier of the project column", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { "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).", "examples": [ - "PR_TITLE" + "MDEzOlByb2plY3RDb2x1bW4zNjc=" ] }, - "merge_commit_message": { + "name": { + "description": "Name of the project column", "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.", "examples": [ - "PR_BODY" + "Remaining tasks" ] }, - "allow_forking": { - "type": "boolean", + "created_at": { + "type": "string", + "format": "date-time", "examples": [ - true + "2016-09-05T14:18:44Z" ] }, - "web_commit_signoff_required": { - "type": "boolean", + "updated_at": { + "type": "string", + "format": "date-time", "examples": [ - false + "2016-09-05T14:22:28Z" ] + } + }, + "required": [ + "id", + "node_id", + "url", + "project_url", + "cards_url", + "name", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "url": "https://api.github.com/projects/columns/367", + "project_url": "https://api.github.com/projects/120", + "cards_url": "https://api.github.com/projects/columns/367/cards", + "id": 367, + "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", + "name": "To Do", + "created_at": "2016-09-05T14:18:44Z", + "updated_at": "2016-09-05T14:22:28Z" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "subscribers_count": { + "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" + } + } + } + } + } + }, + "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": true, + "category": "projects-classic", + "subcategory": "columns", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true + }, + "patch": { + "summary": "Update an existing project column", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "tags": [ + "projects-classic" + ], + "operationId": "projects-classic/update-column", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects-classic/columns#update-an-existing-project-column" + }, + "parameters": [ + { + "name": "column_id", + "description": "The unique identifier of the column.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "description": "Name of the project column", + "type": "string", + "examples": [ + "Remaining tasks" + ] + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "examples": { + "default": { + "summary": "Rename the project column", + "value": { + "name": "To Do" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Project Column", + "description": "Project columns contain cards of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" + ] + }, + "project_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/120" + ] + }, + "cards_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367/cards" + ] + }, + "id": { + "description": "The unique identifier of the project column", "type": "integer", "examples": [ 42 ] }, - "network_count": { - "type": "integer", + "node_id": { + "type": "string", "examples": [ - 0 + "MDEzOlByb2plY3RDb2x1bW4zNjc=" ] }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } + "name": { + "description": "Name of the project column", + "type": "string", + "examples": [ + "Remaining tasks" ] }, - "organization": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:18:44Z" ] }, - "parent": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:22:28Z" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "project_url", + "cards_url", + "name", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "url": "https://api.github.com/projects/columns/367", + "project_url": "https://api.github.com/projects/120", + "cards_url": "https://api.github.com/projects/columns/367/cards", + "id": 367, + "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", + "name": "To Do", + "created_at": "2016-09-05T14:18:44Z", + "updated_at": "2016-09-05T14:22:28Z" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "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": true, + "category": "projects-classic", + "subcategory": "columns", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true + }, + "delete": { + "summary": "Delete a project column", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "tags": [ + "projects-classic" + ], + "operationId": "projects-classic/delete-column", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects-classic/columns#delete-a-project-column" + }, + "parameters": [ + { + "name": "column_id", + "description": "The unique identifier of the column.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "304": { + "description": "Not modified" + }, + "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": true, + "category": "projects-classic", + "subcategory": "columns", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true + } + }, + "/projects/columns/{column_id}/cards": { + "get": { + "summary": "List project cards", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "tags": [ + "projects-classic" + ], + "operationId": "projects-classic/list-cards", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects-classic/cards#list-project-cards" + }, + "parameters": [ + { + "name": "column_id", + "description": "The unique identifier of the column.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "archived_state", + "description": "Filters the project cards that are returned by the card's state.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "all", + "archived", + "not_archived" + ], + "default": "not_archived" + } + }, + { + "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": "Project Card", + "description": "Project cards represent a scope of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/cards/1478" + ] + }, + "id": { + "description": "The project card's ID", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOlByb2plY3RDYXJkMTQ3OA==" + ] + }, + "note": { + "type": [ + "string", + "null" + ], + "examples": [ + "Add payload for delete Project column" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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", + "examples": [ + "2016-09-05T14:21:06Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:20:22Z" + ] + }, + "archived": { + "description": "Whether or not the card is archived", + "type": "boolean", + "examples": [ + false + ] + }, + "column_name": { + "type": "string" + }, + "project_id": { + "type": "string" + }, + "column_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" + ] + }, + "content_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test/issues/3" + ] + }, + "project_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/120" + ] + } + }, + "required": [ + "id", + "node_id", + "note", + "url", + "column_url", + "project_url", + "creator", + "created_at", + "updated_at" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "url": "https://api.github.com/projects/columns/cards/1478", + "id": 1478, + "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", + "note": "Add payload for delete Project column", + "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 }, - "owner": { + "created_at": "2016-09-05T14:21:06Z", + "updated_at": "2016-09-05T14:20:22Z", + "archived": false, + "column_url": "https://api.github.com/projects/columns/367", + "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", + "project_url": "https://api.github.com/projects/120" + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "304": { + "description": "Not modified" + }, + "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": true, + "category": "projects-classic", + "subcategory": "cards", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true + }, + "post": { + "summary": "Create a project card", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "tags": [ + "projects-classic" + ], + "operationId": "projects-classic/create-card", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects-classic/cards#create-a-project-card" + }, + "parameters": [ + { + "name": "column_id", + "description": "The unique identifier of the column.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "note": { + "description": "The project card's note", + "type": [ + "string", + "null" + ], + "examples": [ + "Update all gems" + ] + } + }, + "required": [ + "note" + ] + }, + { + "type": "object", + "properties": { + "content_id": { + "description": "The unique identifier of the content associated with the card", + "type": "integer", + "examples": [ + 42 + ] + }, + "content_type": { + "description": "The piece of content associated with the card", + "type": "string", + "examples": [ + "PullRequest" + ] + } + }, + "required": [ + "content_id", + "content_type" + ] + } + ] + }, + "examples": { + "default": { + "summary": "Create a new card", + "value": { + "note": "Add payload for delete Project column" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Project Card", + "description": "Project cards represent a scope of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/cards/1478" + ] + }, + "id": { + "description": "The project card's ID", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOlByb2plY3RDYXJkMTQ3OA==" + ] + }, + "note": { + "type": [ + "string", + "null" + ], + "examples": [ + "Add payload for delete Project column" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -192183,789 +184888,591 @@ "type", "url" ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:21:06Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:20:22Z" + ] + }, + "archived": { + "description": "Whether or not the card is archived", + "type": "boolean", + "examples": [ + false + ] + }, + "column_name": { + "type": "string" + }, + "project_id": { + "type": "string" + }, + "column_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" + ] + }, + "content_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test/issues/3" + ] + }, + "project_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/120" + ] + } + }, + "required": [ + "id", + "node_id", + "note", + "url", + "column_url", + "project_url", + "creator", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "url": "https://api.github.com/projects/columns/cards/1478", + "id": 1478, + "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", + "note": "Add payload for delete Project column", + "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 + }, + "created_at": "2016-09-05T14:21:06Z", + "updated_at": "2016-09-05T14:20:22Z", + "archived": false, + "column_url": "https://api.github.com/projects/columns/367", + "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", + "project_url": "https://api.github.com/projects/120" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "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" + } + } + } + } + } + }, + "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" }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { + "documentation_url": { "type": "string" }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } } } } - }, - "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" - ] + } }, - "source": { - "title": "Repository", - "description": "A repository on GitHub.", + { + "title": "Validation Error Simple", + "description": "Validation Error Simple", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] + "message": { + "type": "string" }, - "forks": { - "type": "integer" + "documentation_url": { + "type": "string" }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } + "errors": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + ] + } + } + } + }, + "503": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "code": { + "type": "string" }, - "required": [ - "admin", - "pull", - "push" - ] + "message": { + "type": "string" + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects-classic", + "subcategory": "cards", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true + } + }, + "/projects/columns/{column_id}/moves": { + "post": { + "summary": "Move a project column", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "tags": [ + "projects-classic" + ], + "operationId": "projects-classic/move-column", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects-classic/columns#move-a-project-column" + }, + "parameters": [ + { + "name": "column_id", + "description": "The unique identifier of the column.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "position": { + "description": "The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column.", + "type": "string", + "pattern": "^(?:first|last|after:\\d+)$", + "examples": [ + "last" + ] + } + }, + "required": [ + "position" + ], + "type": "object" + }, + "examples": { + "default": { + "summary": "Move the column to the end of the board", + "value": { + "position": "last" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": {}, + "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "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" + } + } + } + } + } + }, + "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" + } + } + } + } + } + } + }, + "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": true, + "category": "projects-classic", + "subcategory": "columns", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true + } + }, + "/projects/{project_id}": { + "get": { + "summary": "Get a project", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "tags": [ + "projects-classic" + ], + "operationId": "projects-classic/get", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects-classic/projects#get-a-project" + }, + "parameters": [ + { + "name": "project_id", + "description": "The unique identifier of the project.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", + "type": "object", + "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/api-playground/projects-test/projects/12" + ] + }, + "columns_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604/columns" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6UHJvamVjdDEwMDI2MDQ=" + ] + }, + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", + "type": [ + "string", + "null" + ], + "examples": [ + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" }, - "owner": { + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -193132,912 +185639,557 @@ "type", "url" ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" ] }, - "forks": { - "type": "integer" + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] }, - "master_branch": { + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "type": "string", + "enum": [ + "read", + "write", + "admin", + "none" + ] + }, + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "number", + "name", + "body", + "state", + "url", + "html_url", + "owner_url", + "creator", + "columns_url", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "owner_url": "https://api.github.com/repos/api-playground/projects-test", + "url": "https://api.github.com/projects/1002604", + "html_url": "https://github.com/api-playground/projects-test/projects/1", + "columns_url": "https://api.github.com/projects/1002604/columns", + "id": 1002604, + "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", + "name": "Projects Documentation", + "body": "Developer documentation project for the developer site.", + "number": 1, + "state": "open", + "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 + }, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { "type": "string" }, - "open_issues": { - "type": "integer" + "documentation_url": { + "type": "string" }, - "watchers": { - "type": "integer" + "url": { + "type": "string" }, - "anonymous_access_enabled": { - "description": "Whether anonymous git access is allowed.", - "default": true, - "type": "boolean" + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "code_of_conduct": { - "title": "Code Of Conduct Simple", - "description": "Code of Conduct Simple", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/github/docs/community/code_of_conduct" - ] - }, - "key": { - "type": "string", - "examples": [ - "citizen_code_of_conduct" - ] - }, - "name": { - "type": "string", - "examples": [ - "Citizen Code of Conduct" - ] - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md" - ] - } - }, - "required": [ - "url", - "key", - "name", - "html_url" + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects-classic", + "subcategory": "projects", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true + }, + "patch": { + "summary": "Update a project", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "operationId": "projects-classic/update", + "tags": [ + "projects-classic" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects-classic/projects#update-a-project" + }, + "parameters": [ + { + "name": "project_id", + "description": "The unique identifier of the project.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", + "type": [ + "string", + "null" + ], + "examples": [ + "This project represents the sprint of the first week in January" + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "organization_permission": { + "description": "The baseline permission that all organization members have on this project", + "type": "string", + "enum": [ + "read", + "write", + "admin", + "none" + ] + }, + "private": { + "description": "Whether or not this project can be seen by everyone.", + "type": "boolean" + } + }, + "type": "object" + }, + "examples": { + "default": { + "summary": "Change the name, state, and permissions for a project", + "value": { + "name": "Week One Sprint", + "state": "open", + "organization_permission": "write" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", + "type": "object", + "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" ] }, - "security_and_analysis": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/api-playground/projects-test/projects/12" + ] + }, + "columns_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604/columns" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6UHJvamVjdDEwMDI2MDQ=" + ] + }, + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", "type": [ - "object", + "string", "null" ], - "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", + "examples": [ + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "status": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { "type": "string", - "enum": [ - "enabled", - "disabled" + "examples": [ + "octocat" ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { "type": "string", - "enum": [ - "enabled", - "disabled" + "examples": [ + "MDQ6VXNlcjE=" ] - } - } - }, - "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.", + }, + "avatar_url": { "type": "string", - "enum": [ - "enabled", - "disabled" + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { "type": "string", - "enum": [ - "enabled", - "disabled" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { + }, + "html_url": { "type": "string", - "enum": [ - "enabled", - "disabled" + "format": "uri", + "examples": [ + "https://github.com/octocat" ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { + }, + "followers_url": { "type": "string", - "enum": [ - "enabled", - "disabled" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { + }, + "following_url": { "type": "string", - "enum": [ - "enabled", - "disabled" + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] } - } + ] }, - "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 + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "type": "string", + "enum": [ + "read", + "write", + "admin", + "none" + ] + }, + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "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", + "number", "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", + "body", + "state", "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "has_discussions", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", + "html_url", + "owner_url", + "creator", + "columns_url", "created_at", - "updated_at", - "network_count", - "subscribers_count" + "updated_at" ] }, "examples": { "default": { "value": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { + "owner_url": "https://api.github.com/repos/api-playground/projects-test", + "url": "https://api.github.com/projects/1002604", + "html_url": "https://github.com/api-playground/projects-test/projects/1", + "columns_url": "https://api.github.com/projects/1002604/columns", + "id": 1002604, + "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", + "name": "Projects Documentation", + "body": "Developer documentation project for the developer site.", + "number": 1, + "state": "open", + "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -194057,489 +186209,37 @@ "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", - "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" - }, - "language": null, - "forks_count": 9, - "forks": 9, - "stargazers_count": 80, - "watchers_count": 80, - "watchers": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "open_issues": 0, - "is_template": false, - "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": { - "pull": true, - "push": false, - "admin": false - }, - "allow_rebase_merge": true, - "template_repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World-Template", - "full_name": "octocat/Hello-World-Template", - "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-Template", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World-Template", - "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World-Template.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World-Template.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World-Template.git", - "mirror_url": "git:git.example.com/octocat/Hello-World-Template", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World-Template", - "homepage": "https://github.com", - "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, - "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", - "allow_squash_merge": true, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "allow_forking": true, - "web_commit_signoff_required": false, - "subscribers_count": 42, - "network_count": 0, - "organization": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "Organization", - "site_admin": false - }, - "parent": { - "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, - "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://api.github.com/licenses/mit" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 - }, - "source": { - "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, - "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://api.github.com/licenses/mit" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" + } + } + } + } + } + }, + "404": { + "description": "Not Found if the authenticated user does not have access to the project" + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "string" } } } @@ -194547,8 +186247,8 @@ } } }, - "307": { - "description": "Temporary Redirect", + "401": { + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -194573,8 +186273,8 @@ } } }, - "403": { - "description": "Forbidden", + "410": { + "description": "Gone", "content": { "application/json": { "schema": { @@ -194604,8 +186304,8 @@ "content": { "application/json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", + "title": "Validation Error Simple", + "description": "Validation Error Simple", "type": "object", "required": [ "message", @@ -194621,130 +186321,56 @@ "errors": { "type": "array", "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } + "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": "repos", - "subcategory": "repos" - } + "category": "projects-classic", + "subcategory": "projects", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true }, "delete": { - "summary": "Delete a repository", - "description": "Deleting a repository requires admin access.\n\nIf an organization owner has configured the organization to prevent members from deleting organization-owned\nrepositories, you will get a `403 Forbidden` response.\n\nOAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint.", + "summary": "Delete a project", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "operationId": "projects-classic/delete", "tags": [ - "repos" + "projects-classic" ], - "operationId": "repos/delete", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/repos#delete-a-repository" + "url": "https://docs.github.com/rest/projects-classic/projects#delete-a-project" }, "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.", + "name": "project_id", + "description": "The unique identifier of the project.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], "responses": { "204": { - "description": "Response" + "description": "Delete Success" + }, + "304": { + "description": "Not modified" }, "403": { - "description": "If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response:", + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -194755,22 +186381,20 @@ }, "documentation_url": { "type": "string" - } - } - }, - "examples": { - "default": { - "value": { - "message": "Organization members cannot delete repositories.", - "documentation_url": "https://docs.github.com/rest/repos/repos#delete-a-repository" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } } } } } } }, - "307": { - "description": "Temporary Redirect", + "401": { + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -194795,8 +186419,8 @@ } } }, - "404": { - "description": "Resource not found", + "410": { + "description": "Gone", "content": { "application/json": { "schema": { @@ -194821,8 +186445,8 @@ } } }, - "409": { - "description": "Conflict", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -194851,40 +186475,49 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "repos" - } + "category": "projects-classic", + "subcategory": "projects", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true } }, - "/repos/{owner}/{repo}/actions/artifacts": { + "/projects/{project_id}/collaborators": { "get": { - "summary": "List artifacts for a repository", - "description": "Lists all artifacts for a repository.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "summary": "List project collaborators", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ - "actions" + "projects-classic" ], - "operationId": "actions/list-artifacts-for-repo", + "operationId": "projects-classic/list-collaborators", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository" + "url": "https://docs.github.com/rest/projects-classic/collaborators#list-project-collaborators" }, "parameters": [ { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", + "name": "project_id", + "description": "The unique identifier of the project.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } }, { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, + "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 organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see.", + "in": "query", + "required": false, "schema": { - "type": "string" + "type": "string", + "enum": [ + "outside", + "direct", + "all" + ], + "default": "all" } }, { @@ -194904,15 +186537,6 @@ "type": "integer", "default": 1 } - }, - { - "name": "name", - "description": "The name field of an artifact. When specified, only artifacts with this name will be returned.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } } ], "responses": { @@ -194921,546 +186545,215 @@ "content": { "application/json": { "schema": { - "type": "object", - "required": [ - "total_count", - "artifacts" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "artifacts": { - "type": "array", - "items": { - "title": "Artifact", - "description": "An artifact", - "type": "object", - "properties": { - "id": { - "type": "integer", - "examples": [ - 5 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOkNoZWNrU3VpdGU1" - ] - }, - "name": { - "description": "The name of the artifact.", - "type": "string", - "examples": [ - "AdventureWorks.Framework" - ] - }, - "size_in_bytes": { - "description": "The size in bytes of the artifact.", - "type": "integer", - "examples": [ - 12345 - ] - }, - "url": { - "type": "string", - "examples": [ - "https://api.github.com/repos/github/hello-world/actions/artifacts/5" - ] - }, - "archive_download_url": { - "type": "string", - "examples": [ - "https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip" - ] - }, - "expired": { - "description": "Whether or not the artifact has expired.", - "type": "boolean" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "expires_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "digest": { - "type": [ - "string", - "null" - ], - "description": "The SHA256 digest of the artifact. This field will only be populated on artifacts uploaded with upload-artifact v4 or newer. For older versions, this field will be null.", - "examples": [ - "sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c" - ] - }, - "workflow_run": { - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "examples": [ - 10 - ] - }, - "repository_id": { - "type": "integer", - "examples": [ - 42 - ] - }, - "head_repository_id": { - "type": "integer", - "examples": [ - 42 - ] - }, - "head_branch": { - "type": "string", - "examples": [ - "main" - ] - }, - "head_sha": { - "type": "string", - "examples": [ - "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" - ] - } - } - } - }, - "required": [ - "id", - "node_id", - "name", - "size_in_bytes", - "url", - "archive_download_url", - "expired", - "created_at", - "expires_at", - "updated_at" + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 2, - "artifacts": [ - { - "id": 11, - "node_id": "MDg6QXJ0aWZhY3QxMQ==", - "name": "Rails", - "size_in_bytes": 556, - "url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11", - "archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip", - "expired": false, - "created_at": "2020-01-10T14:59:22Z", - "expires_at": "2020-03-21T14:59:22Z", - "updated_at": "2020-02-21T14:59:22Z", - "digest": "sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c", - "workflow_run": { - "id": 2332938, - "repository_id": 1296269, - "head_repository_id": 1296269, - "head_branch": "main", - "head_sha": "328faa0536e6fef19753d9d91dc96a9931694ce3" - } - }, - { - "id": 13, - "node_id": "MDg6QXJ0aWZhY3QxMw==", - "name": "Test output", - "size_in_bytes": 453, - "url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13", - "archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13/zip", - "expired": false, - "created_at": "2020-01-10T14:59:22Z", - "expires_at": "2020-03-21T14:59:22Z", - "updated_at": "2020-02-21T14:59:22Z", - "digest": "sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c", - "workflow_run": { - "id": 2332942, - "repository_id": 1296269, - "head_repository_id": 1296269, - "head_branch": "main", - "head_sha": "178f4f6090b3fccad4a65b3e83d076a622d59652" - } - } - ] - } - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "artifacts" - } - } - }, - "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}": { - "get": { - "summary": "Get an artifact", - "description": "Gets a specific artifact for a workflow run.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/get-artifact", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/artifacts#get-an-artifact" - }, - "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": "artifact_id", - "description": "The unique identifier of the artifact.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Artifact", - "description": "An artifact", - "type": "object", - "properties": { - "id": { - "type": "integer", - "examples": [ - 5 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOkNoZWNrU3VpdGU1" - ] - }, - "name": { - "description": "The name of the artifact.", - "type": "string", - "examples": [ - "AdventureWorks.Framework" - ] - }, - "size_in_bytes": { - "description": "The size in bytes of the artifact.", - "type": "integer", - "examples": [ - 12345 - ] - }, - "url": { - "type": "string", - "examples": [ - "https://api.github.com/repos/github/hello-world/actions/artifacts/5" - ] - }, - "archive_download_url": { - "type": "string", - "examples": [ - "https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip" - ] - }, - "expired": { - "description": "Whether or not the artifact has expired.", - "type": "boolean" - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "expires_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "digest": { - "type": [ - "string", - "null" - ], - "description": "The SHA256 digest of the artifact. This field will only be populated on artifacts uploaded with upload-artifact v4 or newer. For older versions, this field will be null.", - "examples": [ - "sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c" - ] - }, - "workflow_run": { - "type": [ - "object", - "null" - ], - "properties": { - "id": { - "type": "integer", - "examples": [ - 10 - ] - }, - "repository_id": { - "type": "integer", - "examples": [ - 42 - ] - }, - "head_repository_id": { - "type": "integer", - "examples": [ - 42 - ] - }, - "head_branch": { - "type": "string", - "examples": [ - "main" - ] - }, - "head_sha": { - "type": "string", - "examples": [ - "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" - ] - } - } - } - }, - "required": [ - "id", - "node_id", - "name", - "size_in_bytes", - "url", - "archive_download_url", - "expired", - "created_at", - "expires_at", - "updated_at" - ] + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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": 11, - "node_id": "MDg6QXJ0aWZhY3QxMQ==", - "name": "Rails", - "size_in_bytes": 556, - "url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11", - "archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip", - "expired": false, - "created_at": "2020-01-10T14:59:22Z", - "expires_at": "2020-01-21T14:59:22Z", - "updated_at": "2020-01-21T14:59:22Z", - "digest": "sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c", - "workflow_run": { - "id": 2332938, - "repository_id": 1296269, - "head_repository_id": 1296269, - "head_branch": "main", - "head_sha": "328faa0536e6fef19753d9d91dc96a9931694ce3" + "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 } - } + ] } } } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "artifacts" - } - }, - "delete": { - "summary": "Delete an artifact", - "description": "Deletes an artifact for a workflow run.\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/delete-artifact", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/artifacts#delete-an-artifact" - }, - "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": "artifact_id", - "description": "The unique identifier of the artifact.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "artifacts" - } - } - }, - "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}": { - "get": { - "summary": "Download an artifact", - "description": "Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in\nthe response header to find the URL for the download. The `:archive_format` must be `zip`.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/download-artifact", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/artifacts#download-an-artifact" - }, - "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": "artifact_id", - "description": "The unique identifier of the artifact.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "archive_format", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "302": { - "description": "Response", + }, "headers": { - "Location": { - "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", + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", "schema": { "type": "string" } } } }, - "410": { - "description": "Gone", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -195484,986 +186777,131 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "artifacts" - } - } - }, - "/repos/{owner}/{repo}/actions/cache/usage": { - "get": { - "summary": "Get GitHub Actions cache usage for a repository", - "description": "Gets GitHub Actions cache usage for a repository.\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\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/get-actions-cache-usage", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-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", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Actions Cache Usage by repository", - "description": "GitHub Actions Cache Usage by repository.", + "title": "Validation Error", + "description": "Validation Error", "type": "object", - "properties": { - "full_name": { - "description": "The repository owner and name for the cache usage being shown.", - "type": "string", - "examples": [ - "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", - "examples": [ - 2322142 - ] - }, - "active_caches_count": { - "description": "The number of active caches in the repository.", - "type": "integer", - "examples": [ - 3 - ] - } - }, "required": [ - "full_name", - "active_caches_size_in_bytes", - "active_caches_count" - ] - }, - "examples": { - "default": { - "value": { - "full_name": "octo-org/Hello-World", - "active_caches_size_in_bytes": 2322142, - "active_caches_count": 3 - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "cache" - } - } - }, - "/repos/{owner}/{repo}/actions/caches": { - "get": { - "summary": "List GitHub Actions caches for a repository", - "description": "Lists the GitHub Actions caches for a repository.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/get-actions-cache-list", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/cache#list-github-actions-caches-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 - } - }, - { - "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 a pull request use `refs/pull//merge`.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "key", - "description": "An explicit key or prefix for identifying the cache", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "sort", - "description": "The property to sort the results by. `created_at` means when the cache was created. `last_accessed_at` means when the cache was last accessed. `size_in_bytes` is the size of the cache in bytes.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created_at", - "last_accessed_at", - "size_in_bytes" - ], - "default": "last_accessed_at" - } - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Repository actions caches", - "description": "Repository actions caches", - "type": "object", + "message", + "documentation_url" + ], "properties": { - "total_count": { - "description": "Total number of caches", - "type": "integer", - "examples": [ - 2 - ] + "message": { + "type": "string" }, - "actions_caches": { - "description": "Array of caches", + "documentation_url": { + "type": "string" + }, + "errors": { "type": "array", "items": { "type": "object", + "required": [ + "code" + ], "properties": { - "id": { - "type": "integer", - "examples": [ - 2 - ] - }, - "ref": { - "type": "string", - "examples": [ - "refs/heads/main" - ] + "resource": { + "type": "string" }, - "key": { - "type": "string", - "examples": [ - "Linux-node-958aff96db2d75d67787d1e634ae70b659de937b" - ] + "field": { + "type": "string" }, - "version": { - "type": "string", - "examples": [ - "73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0" - ] + "message": { + "type": "string" }, - "last_accessed_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2019-01-24T22:45:36.000Z" - ] + "code": { + "type": "string" }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2019-01-24T22:45:36.000Z" - ] + "index": { + "type": "integer" }, - "size_in_bytes": { - "type": "integer", - "examples": [ - 1024 + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } ] } } } } - }, - "required": [ - "total_count", - "actions_caches" - ] - }, - "examples": { - "default": { - "value": { - "total_count": 1, - "actions_caches": [ - { - "id": 505, - "ref": "refs/heads/main", - "key": "Linux-node-958aff96db2d75d67787d1e634ae70b659de937b", - "version": "73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0", - "last_accessed_at": "2019-01-24T22:45:36.000Z", - "created_at": "2019-01-24T22:45:36.000Z", - "size_in_bytes": 1024 - } - ] - } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [], - "category": "actions", - "subcategory": "cache" - } - }, - "delete": { - "summary": "Delete GitHub Actions caches for a repository (using a cache key)", - "description": "Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/delete-actions-cache-by-key", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key" - }, - "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": "key", - "description": "A key for identifying the cache.", - "in": "query", - "required": true, - "schema": { - "type": "string" - } + "304": { + "description": "Not modified" }, - { - "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 a pull request use `refs/pull//merge`.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "title": "Repository actions caches", - "description": "Repository actions caches", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "total_count": { - "description": "Total number of caches", - "type": "integer", - "examples": [ - 2 - ] + "message": { + "type": "string" }, - "actions_caches": { - "description": "Array of caches", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "examples": [ - 2 - ] - }, - "ref": { - "type": "string", - "examples": [ - "refs/heads/main" - ] - }, - "key": { - "type": "string", - "examples": [ - "Linux-node-958aff96db2d75d67787d1e634ae70b659de937b" - ] - }, - "version": { - "type": "string", - "examples": [ - "73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0" - ] - }, - "last_accessed_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2019-01-24T22:45:36.000Z" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2019-01-24T22:45:36.000Z" - ] - }, - "size_in_bytes": { - "type": "integer", - "examples": [ - 1024 - ] - } - } - } - } - }, - "required": [ - "total_count", - "actions_caches" - ] - }, - "examples": { - "default": { - "value": { - "total_count": 1, - "actions_caches": [ - { - "id": 505, - "ref": "refs/heads/main", - "key": "Linux-node-958aff96db2d75d67787d1e634ae70b659de937b", - "version": "73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0", - "last_accessed_at": "2019-01-24T22:45:36.000Z", - "created_at": "2019-01-24T22:45:36.000Z", - "size_in_bytes": 1024 - } - ] + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "cache" - } - } - }, - "/repos/{owner}/{repo}/actions/caches/{cache_id}": { - "delete": { - "summary": "Delete a GitHub Actions cache for a repository (using a cache ID)", - "description": "Deletes a GitHub Actions cache for a repository, using a cache ID.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/delete-actions-cache-by-id", - "externalDocs": { - "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": [ - { - "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": "cache_id", - "description": "The unique identifier of the GitHub Actions cache.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "cache" - } - } - }, - "/repos/{owner}/{repo}/actions/jobs/{job_id}": { - "get": { - "summary": "Get a job for a workflow run", - "description": "Gets a specific job in a workflow run.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/get-job-for-workflow-run", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run" - }, - "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": "job_id", - "description": "The unique identifier of the job.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", + "401": { + "description": "Requires authentication", "content": { "application/json": { "schema": { - "title": "Job", - "description": "Information of a job execution in a workflow run", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "id": { - "description": "The id of the job.", - "type": "integer", - "examples": [ - 21 - ] - }, - "run_id": { - "description": "The id of the associated workflow run.", - "type": "integer", - "examples": [ - 5 - ] - }, - "run_url": { - "type": "string", - "examples": [ - "https://api.github.com/repos/github/hello-world/actions/runs/5" - ] - }, - "run_attempt": { - "type": "integer", - "description": "Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run.", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDg6Q2hlY2tSdW40" - ] + "message": { + "type": "string" }, - "head_sha": { - "description": "The SHA of the commit that is being run.", - "type": "string", - "examples": [ - "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" - ] + "documentation_url": { + "type": "string" }, "url": { - "type": "string", - "examples": [ - "https://api.github.com/repos/github/hello-world/actions/jobs/21" - ] - }, - "html_url": { - "type": [ - "string", - "null" - ], - "examples": [ - "https://github.com/github/hello-world/runs/4" - ] + "type": "string" }, "status": { - "description": "The phase of the lifecycle that the job is currently in.", - "type": "string", - "enum": [ - "queued", - "in_progress", - "completed", - "waiting", - "requested", - "pending" - ], - "examples": [ - "queued" - ] - }, - "conclusion": { - "description": "The outcome of the job.", - "type": [ - "string", - "null" - ], - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "skipped", - "timed_out", - "action_required", - null - ], - "examples": [ - "success" - ] - }, - "created_at": { - "description": "The time that the job created, in ISO 8601 format.", - "format": "date-time", - "type": "string", - "examples": [ - "2019-08-08T08:00:00-07:00" - ] - }, - "started_at": { - "description": "The time that the job started, in ISO 8601 format.", - "format": "date-time", - "type": "string", - "examples": [ - "2019-08-08T08:00:00-07:00" - ] - }, - "completed_at": { - "description": "The time that the job finished, in ISO 8601 format.", - "format": "date-time", - "type": [ - "string", - "null" - ], - "examples": [ - "2019-08-08T08:00:00-07:00" - ] - }, - "name": { - "description": "The name of the job.", - "type": "string", - "examples": [ - "test-coverage" - ] - }, - "steps": { - "description": "Steps in this job.", - "type": "array", - "items": { - "type": "object", - "required": [ - "name", - "status", - "conclusion", - "number" - ], - "properties": { - "status": { - "description": "The phase of the lifecycle that the job is currently in.", - "type": "string", - "enum": [ - "queued", - "in_progress", - "completed" - ], - "examples": [ - "queued" - ] - }, - "conclusion": { - "description": "The outcome of the job.", - "type": [ - "string", - "null" - ], - "examples": [ - "success" - ] - }, - "name": { - "description": "The name of the job.", - "type": "string", - "examples": [ - "test-coverage" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "started_at": { - "description": "The time that the step started, in ISO 8601 format.", - "format": "date-time", - "type": [ - "string", - "null" - ], - "examples": [ - "2019-08-08T08:00:00-07:00" - ] - }, - "completed_at": { - "description": "The time that the job finished, in ISO 8601 format.", - "format": "date-time", - "type": [ - "string", - "null" - ], - "examples": [ - "2019-08-08T08:00:00-07:00" - ] - } - } - } - }, - "check_run_url": { - "type": "string", - "examples": [ - "https://api.github.com/repos/github/hello-world/check-runs/4" - ] - }, - "labels": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Labels for the workflow job. Specified by the \"runs_on\" attribute in the action's workflow file.", - "examples": [ - "self-hosted", - "foo", - "bar" - ] - }, - "runner_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", - "examples": [ - 1 - ] - }, - "runner_name": { - "type": [ - "string", - "null" - ], - "description": "The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", - "examples": [ - "my runner" - ] - }, - "runner_group_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", - "examples": [ - 2 - ] - }, - "runner_group_name": { - "type": [ - "string", - "null" - ], - "description": "The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", - "examples": [ - "my runner group" - ] - }, - "workflow_name": { - "type": [ - "string", - "null" - ], - "description": "The name of the workflow.", - "examples": [ - "Build" - ] - }, - "head_branch": { - "type": [ - "string", - "null" - ], - "description": "The name of the current branch.", - "examples": [ - "main" - ] - } - }, - "required": [ - "id", - "node_id", - "run_id", - "run_url", - "head_sha", - "workflow_name", - "head_branch", - "name", - "url", - "html_url", - "status", - "conclusion", - "started_at", - "completed_at", - "check_run_url", - "labels", - "runner_id", - "runner_name", - "runner_group_id", - "runner_group_name", - "created_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 399444496, - "run_id": 29679449, - "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449", - "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==", - "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0", - "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496", - "html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496", - "status": "completed", - "conclusion": "success", - "started_at": "2020-01-20T17:42:40Z", - "completed_at": "2020-01-20T17:44:39Z", - "name": "build", - "steps": [ - { - "name": "Set up job", - "status": "completed", - "conclusion": "success", - "number": 1, - "started_at": "2020-01-20T09:42:40.000-08:00", - "completed_at": "2020-01-20T09:42:41.000-08:00" - }, - { - "name": "Run actions/checkout@v2", - "status": "completed", - "conclusion": "success", - "number": 2, - "started_at": "2020-01-20T09:42:41.000-08:00", - "completed_at": "2020-01-20T09:42:45.000-08:00" - }, - { - "name": "Set up Ruby", - "status": "completed", - "conclusion": "success", - "number": 3, - "started_at": "2020-01-20T09:42:45.000-08:00", - "completed_at": "2020-01-20T09:42:45.000-08:00" - }, - { - "name": "Run actions/cache@v3", - "status": "completed", - "conclusion": "success", - "number": 4, - "started_at": "2020-01-20T09:42:45.000-08:00", - "completed_at": "2020-01-20T09:42:48.000-08:00" - }, - { - "name": "Install Bundler", - "status": "completed", - "conclusion": "success", - "number": 5, - "started_at": "2020-01-20T09:42:48.000-08:00", - "completed_at": "2020-01-20T09:42:52.000-08:00" - }, - { - "name": "Install Gems", - "status": "completed", - "conclusion": "success", - "number": 6, - "started_at": "2020-01-20T09:42:52.000-08:00", - "completed_at": "2020-01-20T09:42:53.000-08:00" - }, - { - "name": "Run Tests", - "status": "completed", - "conclusion": "success", - "number": 7, - "started_at": "2020-01-20T09:42:53.000-08:00", - "completed_at": "2020-01-20T09:42:59.000-08:00" - }, - { - "name": "Deploy to Heroku", - "status": "completed", - "conclusion": "success", - "number": 8, - "started_at": "2020-01-20T09:42:59.000-08:00", - "completed_at": "2020-01-20T09:44:39.000-08:00" - }, - { - "name": "Post actions/cache@v3", - "status": "completed", - "conclusion": "success", - "number": 16, - "started_at": "2020-01-20T09:44:39.000-08:00", - "completed_at": "2020-01-20T09:44:39.000-08:00" - }, - { - "name": "Complete job", - "status": "completed", - "conclusion": "success", - "number": 17, - "started_at": "2020-01-20T09:44:39.000-08:00", - "completed_at": "2020-01-20T09:44:39.000-08:00" - } - ], - "check_run_url": "https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496", - "labels": [ - "self-hosted", - "foo", - "bar" - ], - "runner_id": 1, - "runner_name": "my runner", - "runner_group_id": 2, - "runner_group_name": "my runner group", - "workflow_name": "CI", - "head_branch": "main" + "type": "string" } } } @@ -196474,112 +186912,44 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "workflow-jobs" - } - } - }, - "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs": { - "get": { - "summary": "Download job logs for a workflow run", - "description": "Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look\nfor `Location:` in the response header to find the URL for the download.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/download-job-logs-for-workflow-run", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run" - }, - "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": "job_id", - "description": "The unique identifier of the job.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "302": { - "description": "Response", - "headers": { - "Location": { - "example": "https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/jobs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D", - "schema": { - "type": "string" - } - } - } - } + "category": "projects-classic", + "subcategory": "collaborators", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "workflow-jobs" - } + "deprecated": true } }, - "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun": { - "post": { - "summary": "Re-run a job from a workflow run", - "description": "Re-run a job and its dependent jobs in a workflow run.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "/projects/{project_id}/collaborators/{username}": { + "put": { + "summary": "Add project collaborator", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ - "actions" + "projects-classic" ], - "operationId": "actions/re-run-job-for-workflow-run", + "operationId": "projects-classic/add-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run" + "url": "https://docs.github.com/rest/projects-classic/collaborators#add-project-collaborator" }, "parameters": [ { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", + "name": "project_id", + "description": "The unique identifier of the project.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } }, { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "name": "username", + "description": "The handle for the GitHub user account.", "in": "path", "required": true, "schema": { "type": "string" } - }, - { - "name": "job_id", - "description": "The unique identifier of the job.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "requestBody": { @@ -196592,43 +186962,38 @@ "null" ], "properties": { - "enable_debug_logging": { - "type": "boolean", - "default": false, - "description": "Whether to enable debug logging for the re-run." + "permission": { + "description": "The permission to grant the collaborator.", + "enum": [ + "read", + "write", + "admin" + ], + "default": "write", + "type": "string", + "examples": [ + "write" + ] } } }, "examples": { "default": { - "value": null + "summary": "Applying write permissions for the new collaborator", + "value": { + "permission": "write" + } } } } } }, "responses": { - "201": { - "description": "Response", - "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" }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -196652,90 +187017,87 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "workflow-runs" - } - } - }, - "/repos/{owner}/{repo}/actions/oidc/customization/sub": { - "get": { - "summary": "Get the customization template for an OIDC subject claim for a repository", - "description": "Gets the customization template for an OpenID Connect (OIDC) subject claim.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/get-custom-oidc-sub-claim-for-repo", - "externalDocs": { - "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": [ - { - "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": "Status response", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Actions OIDC subject customization for a repository", - "description": "Actions OIDC subject customization for a repository", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { - "use_default": { - "description": "Whether to use the default template or not. If `true`, the `include_claim_keys` field is ignored.", - "type": "boolean" + "message": { + "type": "string" }, - "include_claim_keys": { - "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.", + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } } } - }, - "required": [ - "use_default" - ] - }, - "examples": { - "default": { - "value": { - "use_default": false, - "include_claim_keys": [ - "repo", - "context" - ] - } } } } } }, - "400": { - "description": "Bad Request", + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -196757,53 +187119,11 @@ } } } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": [ - "string", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } } } }, - "404": { - "description": "Resource not found", + "401": { + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -196830,36 +187150,39 @@ } }, "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [], - "category": "actions", - "subcategory": "oidc" - } + "category": "projects-classic", + "subcategory": "collaborators", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true }, - "put": { - "summary": "Set the customization template for an OIDC subject claim for a repository", - "description": "Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "delete": { + "summary": "Remove user as a collaborator", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ - "actions" + "projects-classic" ], - "operationId": "actions/set-custom-oidc-sub-claim-for-repo", + "operationId": "projects-classic/remove-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository" + "url": "https://docs.github.com/rest/projects-classic/collaborators#remove-user-as-a-collaborator" }, "parameters": [ { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", + "name": "project_id", + "description": "The unique identifier of the project.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } }, { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "name": "username", + "description": "The handle for the GitHub user account.", "in": "path", "required": true, "schema": { @@ -196867,64 +187190,12 @@ } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "title": "Actions OIDC subject customization for a repository", - "description": "Actions OIDC subject customization for a repository", - "type": "object", - "required": [ - "use_default" - ], - "properties": { - "use_default": { - "description": "Whether to use the default template or not. If `true`, the `include_claim_keys` field is ignored.", - "type": "boolean" - }, - "include_claim_keys": { - "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "examples": { - "default": { - "value": { - "use_default": false, - "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 - } - } - } - } + "204": { + "description": "Response" + }, + "304": { + "description": "Not modified" }, "404": { "description": "Resource not found", @@ -196952,8 +187223,8 @@ } } }, - "400": { - "description": "Bad Request", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -196975,48 +187246,6 @@ } } } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": [ - "string", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } } } }, @@ -197025,8 +187254,8 @@ "content": { "application/json": { "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", + "title": "Validation Error", + "description": "Validation Error", "type": "object", "required": [ "message", @@ -197042,337 +187271,122 @@ "errors": { "type": "array", "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "previews": [], - "category": "actions", - "subcategory": "oidc" - } - } - }, - "/repos/{owner}/{repo}/actions/organization-secrets": { - "get": { - "summary": "List repository organization secrets", - "description": "Lists all organization secrets shared with a repository without revealing their encrypted\nvalues.\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 `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/list-repo-organization-secrets", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets" - }, - "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": "object", - "required": [ - "total_count", - "secrets" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "secrets": { - "type": "array", - "items": { - "title": "Actions Secret", - "description": "Set secrets for GitHub Actions.", "type": "object", + "required": [ + "code" + ], "properties": { - "name": { - "description": "The name of the secret.", - "type": "string", - "examples": [ - "SECRET_TOKEN" - ] + "resource": { + "type": "string" }, - "created_at": { - "type": "string", - "format": "date-time" + "field": { + "type": "string" }, - "updated_at": { - "type": "string", - "format": "date-time" + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] } - }, - "required": [ - "name", - "created_at", - "updated_at" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 2, - "secrets": [ - { - "name": "GH_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z" - }, - { - "name": "GIST_ID", - "created_at": "2020-01-10T10:59:22Z", - "updated_at": "2020-01-11T11:59:22Z" } - ] + } } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - } - } - }, - "/repos/{owner}/{repo}/actions/organization-variables": { - "get": { - "summary": "List repository organization variables", - "description": "Lists all organization variables shared with a repository.\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 `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/list-repo-organization-variables", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/variables#list-repository-organization-variables" - }, - "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 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", + "401": { + "description": "Requires authentication", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "required": [ - "total_count", - "variables" - ], "properties": { - "total_count": { - "type": "integer" + "message": { + "type": "string" }, - "variables": { - "type": "array", - "items": { - "title": "Actions Variable", - "type": "object", - "properties": { - "name": { - "description": "The name of the variable.", - "type": "string", - "examples": [ - "USERNAME" - ] - }, - "value": { - "description": "The value of the variable.", - "type": "string", - "examples": [ - "octocat" - ] - }, - "created_at": { - "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time", - "examples": [ - "2019-01-24T22:45:36.000Z" - ] - }, - "updated_at": { - "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time", - "examples": [ - "2019-01-24T22:45:36.000Z" - ] - } - }, - "required": [ - "name", - "value", - "created_at", - "updated_at" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 2, - "variables": [ - { - "name": "USERNAME", - "value": "octocat", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z" - }, - { - "name": "EMAIL", - "value": "octocat@github.com", - "created_at": "2020-01-10T10:59:22Z", - "updated_at": "2020-01-11T11:59:22Z" - } - ] + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - } + "category": "projects-classic", + "subcategory": "collaborators", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true } }, - "/repos/{owner}/{repo}/actions/permissions": { + "/projects/{project_id}/collaborators/{username}/permission": { "get": { - "summary": "Get GitHub Actions permissions for a repository", - "description": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "operationId": "actions/get-github-actions-permissions-repository", + "summary": "Get project permission for a user", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ - "actions" + "projects-classic" ], + "operationId": "projects-classic/get-permission-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository" + "url": "https://docs.github.com/rest/projects-classic/collaborators#get-project-permission-for-a-user" }, "parameters": [ { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", + "name": "project_id", + "description": "The unique identifier of the project.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } }, { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "name": "username", + "description": "The handle for the GitHub user account.", "in": "path", "required": true, "schema": { @@ -197386,506 +187400,374 @@ "content": { "application/json": { "schema": { + "title": "Project Collaborator Permission", + "description": "Project Collaborator Permission", "type": "object", "properties": { - "enabled": { - "type": "boolean", - "description": "Whether GitHub Actions is enabled on the repository." + "permission": { + "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" + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } ] - }, - "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" + "permission", + "user" ] }, "examples": { "default": { "value": { - "enabled": true, - "allowed_actions": "selected", - "selected_actions_url": "https://api.github.com/repositories/42/actions/permissions/selected-actions" + "permission": "admin", + "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 + } } } } } } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "githubCloudOnly": false, - "category": "actions", - "subcategory": "permissions" - } - }, - "put": { - "summary": "Set GitHub Actions permissions for a repository", - "description": "Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "operationId": "actions/set-github-actions-permissions-repository", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#set-github-actions-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" - } - }, - "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", + "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" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [], - "category": "actions", - "subcategory": "permissions" - } - } - }, - "/repos/{owner}/{repo}/actions/permissions/selected-actions": { - "get": { - "summary": "Get allowed actions and reusable workflows for a repository", - "description": "Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "operationId": "actions/get-allowed-actions-repository", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-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", + "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": { - "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": { + "errors": { "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" + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } } } } - }, - "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 a repository", - "description": "Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "operationId": "actions/set-allowed-actions-repository", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-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" - } - }, - "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": { + "304": { + "description": "Not modified" + }, + "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": { - "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" - } - } - }, - "/repos/{owner}/{repo}/actions/permissions/workflow": { - "get": { - "summary": "Get default workflow permissions for a repository", - "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository,\nas well as if GitHub Actions can submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/get-github-actions-default-workflow-permissions-repository", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#get-default-workflow-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", + "401": { + "description": "Requires authentication", "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" } } } @@ -197896,127 +187778,34 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - }, - "put": { - "summary": "Set default workflow permissions for a repository", - "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions\ncan submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/set-github-actions-default-workflow-permissions-repository", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#set-default-workflow-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": "Success response" - }, - "409": { - "description": "Conflict response when changing a setting is prevented by the owning organization" - } - }, - "requestBody": { - "required": true, - "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 - } - } - } - } - } + "category": "projects-classic", + "subcategory": "collaborators", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } + "deprecated": true } }, - "/repos/{owner}/{repo}/actions/runners": { + "/projects/{project_id}/columns": { "get": { - "summary": "List self-hosted runners for a repository", - "description": "Lists all self-hosted runners configured in a repository.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "summary": "List project columns", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ - "actions" + "projects-classic" ], - "operationId": "actions/list-self-hosted-runners-for-repo", + "operationId": "projects-classic/list-columns", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-a-repository" + "url": "https://docs.github.com/rest/projects-classic/columns#list-project-columns" }, "parameters": [ { - "name": "name", - "description": "The name of a self-hosted runner.", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "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.", + "name": "project_id", + "description": "The unique identifier of the project.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } }, { @@ -198044,167 +187833,94 @@ "content": { "application/json": { "schema": { - "type": "object", - "required": [ - "total_count", - "runners" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "runners": { - "type": "array", - "items": { - "title": "Self hosted runners", - "description": "A self hosted runner", - "type": "object", - "properties": { - "id": { - "description": "The ID of the runner.", - "type": "integer", - "examples": [ - 5 - ] - }, - "runner_group_id": { - "description": "The ID of the runner group.", - "type": "integer", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the runner.", - "type": "string", - "examples": [ - "iMac" - ] - }, - "os": { - "description": "The Operating System of the runner.", - "type": "string", - "examples": [ - "macos" - ] - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "examples": [ - "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" + "type": "array", + "items": { + "title": "Project Column", + "description": "Project columns contain cards of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" + ] + }, + "project_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/120" + ] + }, + "cards_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367/cards" + ] + }, + "id": { + "description": "The unique identifier of the project column", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEzOlByb2plY3RDb2x1bW4zNjc=" + ] + }, + "name": { + "description": "Name of the project column", + "type": "string", + "examples": [ + "Remaining tasks" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:18:44Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:22:28Z" ] } - } + }, + "required": [ + "id", + "node_id", + "url", + "project_url", + "cards_url", + "name", + "created_at", + "updated_at" + ] } }, "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" - } - ] - } - ] - } + "value": [ + { + "url": "https://api.github.com/projects/columns/367", + "project_url": "https://api.github.com/projects/120", + "cards_url": "https://api.github.com/projects/columns/367/cards", + "id": 367, + "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", + "name": "To Do", + "created_at": "2016-09-05T14:18:44Z", + "updated_at": "2016-09-05T14:22:28Z" + } + ] } } } @@ -198217,122 +187933,57 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "self-hosted-runners" - } - } - }, - "/repos/{owner}/{repo}/actions/runners/downloads": { - "get": { - "summary": "List runner applications for a repository", - "description": "Lists binaries for the runner application that you can download and run.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/list-runner-applications-for-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-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", + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", "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": { - "type": "string" - } + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "required": [ - "os", - "architecture", - "download_url", - "filename" - ] + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } } - }, - "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" - } - ] + } + } + } + }, + "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" + } } } } @@ -198342,40 +187993,32 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "self-hosted-runners" - } - } - }, - "/repos/{owner}/{repo}/actions/runners/generate-jitconfig": { + "category": "projects-classic", + "subcategory": "columns", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true + }, "post": { - "summary": "Create configuration for a just-in-time runner for a repository", - "description": "Generates a configuration that can be passed to the runner application at startup.\n\nThe authenticated user must have admin access to the repository.\n\nOAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint.", + "summary": "Create a project column", + "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", "tags": [ - "actions" + "projects-classic" ], - "operationId": "actions/generate-runner-jitconfig-for-repo", + "operationId": "projects-classic/create-column", "externalDocs": { "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" + "url": "https://docs.github.com/rest/projects-classic/columns#create-a-project-column" }, "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.", + "name": "project_id", + "description": "The unique identifier of the project.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], @@ -198384,49 +188027,24 @@ "content": { "application/json": { "schema": { - "type": "object", - "required": [ - "name", - "runner_group_id", - "labels" - ], "properties": { "name": { + "description": "Name of the project column", "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": { - "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" + "examples": [ + "Remaining tasks" + ] } - } + }, + "required": [ + "name" + ], + "type": "object" }, "examples": { "default": { "value": { - "name": "New runner", - "runner_group_id": 1, - "labels": [ - "self-hosted", - "X64", - "macOS", - "no-gpu" - ], - "work_folder": "_work" + "name": "Remaining tasks" } } } @@ -198439,144 +188057,99 @@ "content": { "application/json": { "schema": { + "title": "Project Column", + "description": "Project columns contain cards of work.", "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", - "examples": [ - 5 - ] - }, - "runner_group_id": { - "description": "The ID of the runner group.", - "type": "integer", - "examples": [ - 1 - ] - }, - "name": { - "description": "The name of the runner.", - "type": "string", - "examples": [ - "iMac" - ] - }, - "os": { - "description": "The Operating System of the runner.", - "type": "string", - "examples": [ - "macos" - ] - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "examples": [ - "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" + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" ] }, - "encoded_jit_config": { + "project_url": { "type": "string", - "description": "The base64 encoded runner configuration." + "format": "uri", + "examples": [ + "https://api.github.com/projects/120" + ] + }, + "cards_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367/cards" + ] + }, + "id": { + "description": "The unique identifier of the project column", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEzOlByb2plY3RDb2x1bW4zNjc=" + ] + }, + "name": { + "description": "Name of the project column", + "type": "string", + "examples": [ + "Remaining tasks" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:18:44Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:22:28Z" + ] } - } + }, + "required": [ + "id", + "node_id", + "url", + "project_url", + "cards_url", + "name", + "created_at", + "updated_at" + ] }, "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" + "url": "https://api.github.com/projects/columns/367", + "project_url": "https://api.github.com/projects/120", + "cards_url": "https://api.github.com/projects/columns/367/cards", + "id": 367, + "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", + "name": "To Do", + "created_at": "2016-09-05T14:18:44Z", + "updated_at": "2016-09-05T14:22:28Z" } } } } } }, - "404": { - "description": "Resource not found", + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -198631,8 +188204,8 @@ } } }, - "409": { - "description": "Conflict", + "401": { + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -198661,1058 +188234,491 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "self-hosted-runners" - } + "category": "projects-classic", + "subcategory": "columns", + "deprecationDate": "2024-05-23", + "removalDate": "2025-04-01" + }, + "deprecated": true } }, - "/repos/{owner}/{repo}/actions/runners/registration-token": { - "post": { - "summary": "Create a registration token for a repository", - "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 repository to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "/rate_limit": { + "get": { + "summary": "Get rate limit status for the authenticated user", + "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners).\"\n* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", "tags": [ - "actions" + "rate-limit" ], - "operationId": "actions/create-registration-token-for-repo", + "operationId": "rate-limit/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository" + "url": "https://docs.github.com/rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user" }, - "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" - } - } - ], + "parameters": [], "responses": { - "201": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Authentication Token", - "description": "Authentication Token", + "title": "Rate Limit Overview", + "description": "Rate Limit Overview", "type": "object", "properties": { - "token": { - "description": "The token used for authentication", - "type": "string", - "examples": [ - "v1.1f699f1069f60xxx" - ] - }, - "expires_at": { - "description": "The time this token expires", - "type": "string", - "format": "date-time", - "examples": [ - "2016-07-11T22:14:10Z" - ] - }, - "permissions": { + "resources": { "type": "object", - "examples": [ - { - "issues": "read", - "deployments": "write" - } - ] - }, - "repositories": { - "description": "The repositories this token has access to", - "type": "array", - "items": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] + "properties": { + "core": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "graphql": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "search": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "code_search": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + "remaining": { + "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" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" } }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "source_import": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } }, - "open_issues": { - "type": "integer" + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "integration_manifest": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } }, - "watchers": { - "type": "integer" + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "code_scanning_upload": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } }, - "master_branch": { - "type": "string" + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "actions_runner_registration": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "scim": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "dependency_snapshots": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } }, - "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": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "dependency_sbom": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" } - } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] }, - "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" - ] - } - }, - "single_file": { - "type": [ - "string", - "null" - ], - "examples": [ - "config.yaml" + "code_scanning_autofix": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + } + }, + "required": [ + "core", + "search" ] }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" + "rate": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" ] } }, "required": [ - "token", - "expires_at" + "rate", + "resources" ] }, "examples": { "default": { "value": { - "token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6", - "expires_at": "2020-01-22T12:13:35.123-08:00" + "resources": { + "core": { + "limit": 5000, + "used": 1, + "remaining": 4999, + "reset": 1691591363 + }, + "search": { + "limit": 30, + "used": 12, + "remaining": 18, + "reset": 1691591091 + }, + "graphql": { + "limit": 5000, + "used": 7, + "remaining": 4993, + "reset": 1691593228 + }, + "integration_manifest": { + "limit": 5000, + "used": 1, + "remaining": 4999, + "reset": 1691594631 + }, + "source_import": { + "limit": 100, + "used": 1, + "remaining": 99, + "reset": 1691591091 + }, + "code_scanning_upload": { + "limit": 500, + "used": 1, + "remaining": 499, + "reset": 1691594631 + }, + "actions_runner_registration": { + "limit": 10000, + "used": 0, + "remaining": 10000, + "reset": 1691594631 + }, + "scim": { + "limit": 15000, + "used": 0, + "remaining": 15000, + "reset": 1691594631 + }, + "dependency_snapshots": { + "limit": 100, + "used": 0, + "remaining": 100, + "reset": 1691591091 + }, + "code_search": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 + }, + "code_scanning_autofix": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 + } + }, + "rate": { + "limit": 5000, + "used": 1, + "remaining": 4999, + "reset": 1372700873 + } + } + } + } + } + }, + "headers": { + "X-RateLimit-Limit": { + "example": 5000, + "schema": { + "type": "integer" + } + }, + "X-RateLimit-Remaining": { + "example": 4999, + "schema": { + "type": "integer" + } + }, + "X-RateLimit-Reset": { + "example": 1590701888, + "schema": { + "type": "integer", + "format": "timestamp" + } + } + } + }, + "304": { + "description": "Not modified" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } @@ -199723,22 +188729,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "self-hosted-runners" + "category": "rate-limit", + "subcategory": "rate-limit" } } }, - "/repos/{owner}/{repo}/actions/runners/remove-token": { - "post": { - "summary": "Create a remove token for a repository", - "description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. 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 repository to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "/repos/{owner}/{repo}": { + "get": { + "summary": "Get a repository", + "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n> [!NOTE]\n> In order to see the `security_and_analysis` block for a repository 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).\"", "tags": [ - "actions" + "repos" ], - "operationId": "actions/create-remove-token-for-repo", + "operationId": "repos/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository" + "url": "https://docs.github.com/rest/repos/repos#get-a-repository" }, "parameters": [ { @@ -199761,2969 +188767,18650 @@ } ], "responses": { - "201": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Authentication Token", - "description": "Authentication Token", + "title": "Full Repository", + "description": "Full Repository", "type": "object", "properties": { - "token": { - "description": "The token used for authentication", + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] + }, + "node_id": { "type": "string", "examples": [ - "v1.1f699f1069f60xxx" + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "expires_at": { - "description": "The time this token expires", + "name": { "type": "string", - "format": "date-time", "examples": [ - "2016-07-11T22:14:10Z" + "Hello-World" ] }, - "permissions": { - "type": "object", + "full_name": { + "type": "string", "examples": [ - { - "issues": "read", - "deployments": "write" + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, - "repositories": { - "description": "The repositories this token has access to", + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { "type": "array", "items": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] - } - }, - "single_file": { - "type": [ - "string", - "null" - ], + "type": "string" + }, "examples": [ - "config.yaml" + "octocat", + "atom", + "electron", + "API" ] }, - "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" - } - } - }, - "/repos/{owner}/{repo}/actions/runners/{runner_id}": { - "get": { - "summary": "Get a self-hosted runner for a repository", - "description": "Gets a specific self-hosted runner configured in a repository.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/get-self-hosted-runner-for-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-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": "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", + "has_issues": { + "type": "boolean", "examples": [ - 5 + true ] }, - "runner_group_id": { - "description": "The ID of the runner group.", - "type": "integer", + "has_projects": { + "type": "boolean", "examples": [ - 1 + true ] }, - "name": { - "description": "The name of the runner.", - "type": "string", + "has_wiki": { + "type": "boolean", "examples": [ - "iMac" + true ] }, - "os": { - "description": "The Operating System of the runner.", - "type": "string", + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean", "examples": [ - "macos" + true ] }, - "status": { - "description": "The status of the runner.", - "type": "string", + "has_discussions": { + "type": "boolean", "examples": [ - "online" + true ] }, - "busy": { + "archived": { "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" - ] - } + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." }, - "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" - }, - { - "id": 21, - "name": "no-gpu", - "type": "custom" - } + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "type": "string", + "examples": [ + "public" ] - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "self-hosted-runners" - } - }, - "delete": { - "summary": "Delete a self-hosted runner from a repository", - "description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/delete-self-hosted-runner-from-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-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": "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" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "self-hosted-runners" - } - } - }, - "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels": { - "get": { - "summary": "List labels for a self-hosted runner for a repository", - "description": "Lists all labels for a self-hosted runner configured in a repository.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/list-labels-for-self-hosted-runner-for-repo", - "externalDocs": { - "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": [ - { - "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": "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": { - "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" - } + "pushed_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" ] - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/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": "self-hosted-runners" - } - }, - "post": { - "summary": "Add custom labels to a self-hosted runner for a repository", - "description": "Adds custom labels to a self-hosted runner configured in a repository.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/add-custom-labels-to-self-hosted-runner-for-repo", - "externalDocs": { - "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": [ - { - "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": "runner_id", - "description": "Unique identifier of the self-hosted runner.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "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": { - "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" - } + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" ] - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/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": "actions", - "subcategory": "self-hosted-runners" - } - }, - "put": { - "summary": "Set custom labels for a self-hosted runner for a repository", - "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/set-custom-labels-for-self-hosted-runner-for-repo", - "externalDocs": { - "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": [ - { - "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": "runner_id", - "description": "Unique identifier of the self-hosted runner.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "labels" - ], - "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": { - "default": { - "value": { - "labels": [ - "gpu", - "accelerated" - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "labels" - ], - "properties": { - "total_count": { - "type": "integer" + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] }, - "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" - ] - } + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" }, - "required": [ - "name" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 4, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" + "maintain": { + "type": "boolean" }, - { - "id": 7, - "name": "X64", - "type": "read-only" + "push": { + "type": "boolean" }, - { - "id": 20, - "name": "macOS", - "type": "read-only" + "triage": { + "type": "boolean" }, - { - "id": 21, - "name": "no-gpu", - "type": "custom" + "pull": { + "type": "boolean" } + }, + "required": [ + "admin", + "pull", + "push" ] - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/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": "actions", - "subcategory": "self-hosted-runners" - } - }, - "delete": { - "summary": "Remove all custom labels from a self-hosted runner for a repository", - "description": "Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/remove-all-custom-labels-from-self-hosted-runner-for-repo", - "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-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": "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": { - "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" - } + "allow_rebase_merge": { + "type": "boolean", + "examples": [ + 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": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "self-hosted-runners" - } - } - }, - "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}": { - "delete": { - "summary": "Remove a custom label from a self-hosted runner for a repository", - "description": "Remove a custom label from a self-hosted runner configured\nin a repository. 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 repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/remove-custom-label-from-self-hosted-runner-for-repo", - "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-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": "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", - "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" - }, + "template_repository": { + "anyOf": [ { - "id": 20, - "name": "macOS", - "type": "read-only" + "type": "null" }, { - "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" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "self-hosted-runners" - } - } - }, - "/repos/{owner}/{repo}/actions/runs": { - "get": { - "summary": "List workflow runs for a repository", - "description": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.\n\nThis endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.", - "tags": [ - "actions" - ], - "operationId": "actions/list-workflow-runs-for-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-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": "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.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "Returns workflow runs associated with a branch. Use the name of the branch of the `push`.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "event", - "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "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 can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "completed", - "action_required", - "cancelled", - "failure", - "neutral", - "skipped", - "stale", - "success", - "timed_out", - "in_progress", - "queued", - "requested", - "waiting", - "pending" - ] - } - }, - { - "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": "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).\"", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "exclude_pull_requests", - "description": "If `true` pull requests are omitted from the response (empty array).", - "in": "query", - "required": false, - "schema": { - "type": "boolean", - "default": false - } - }, - { - "name": "check_suite_id", - "description": "Returns workflow runs with the `check_suite_id` that you specify.", - "in": "query", - "schema": { - "type": "integer" - } - }, - { - "name": "head_sha", - "description": "Only returns workflow runs that are associated with the specified `head_sha`.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "workflow_runs" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "workflow_runs": { - "type": "array", - "items": { - "title": "Workflow Run", - "description": "An invocation of a workflow", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the workflow run.", - "examples": [ - 5 - ] - }, - "name": { - "type": [ - "string", - "null" - ], - "description": "The name of the workflow run.", - "examples": [ - "Build" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOkNoZWNrU3VpdGU1" - ] - }, - "check_suite_id": { - "type": "integer", - "description": "The ID of the associated check suite.", - "examples": [ - 42 - ] - }, - "check_suite_node_id": { - "type": "string", - "description": "The node ID of the associated check suite.", - "examples": [ - "MDEwOkNoZWNrU3VpdGU0Mg==" - ] - }, - "head_branch": { - "type": [ - "string", - "null" - ], - "examples": [ - "master" - ] - }, - "head_sha": { - "description": "The SHA of the head commit that points to the version of the workflow being run.", - "type": "string", - "examples": [ - "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" - ] - }, - "path": { - "description": "The full path of the workflow", - "type": "string", - "examples": [ - "octocat/octo-repo/.github/workflows/ci.yml@main" - ] - }, - "run_number": { - "type": "integer", - "description": "The auto incrementing run number for the workflow run.", - "examples": [ - 106 - ] - }, - "run_attempt": { - "type": "integer", - "description": "Attempt number of the run, 1 for first attempt and higher if the workflow was re-run.", - "examples": [ - 1 - ] - }, - "referenced_workflows": { - "type": [ - "array", - "null" - ], - "items": { - "title": "Referenced workflow", - "description": "A workflow referenced/reused by the initial caller workflow", + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { "type": "object", "properties": { - "path": { - "type": "string" + "admin": { + "type": "boolean" }, - "sha": { - "type": "string" + "pull": { + "type": "boolean" }, - "ref": { - "type": "string" + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" } }, "required": [ - "path", - "sha" + "admin", + "pull", + "push" ] - } - }, - "event": { - "type": "string", - "examples": [ - "push" - ] - }, - "status": { - "type": [ - "string", - "null" - ], - "examples": [ - "completed" - ] - }, - "conclusion": { - "type": [ - "string", - "null" - ], - "examples": [ - "neutral" - ] - }, - "workflow_id": { - "type": "integer", - "description": "The ID of the parent workflow.", - "examples": [ - 5 - ] - }, - "url": { - "type": "string", - "description": "The URL to the workflow run.", - "examples": [ - "https://api.github.com/repos/github/hello-world/actions/runs/5" - ] - }, - "html_url": { - "type": "string", - "examples": [ - "https://github.com/github/hello-world/suites/4" - ] - }, - "pull_requests": { - "description": "Pull requests that are open with a `head_sha` or `head_branch` that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run.", - "type": [ - "array", - "null" - ], - "items": { - "title": "Pull Request Minimal", + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, "id": { "type": "integer", - "format": "int64" + "format": "int64", + "examples": [ + 1 + ] }, - "number": { - "type": "integer" + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] }, "url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] }, - "head": { - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "repo": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "name" - ] - } - }, - "required": [ - "ref", - "sha", - "repo" + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" ] }, - "base": { - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "repo": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "name" - ] - } - }, - "required": [ - "ref", - "sha", - "repo" + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", "id", - "number", - "url", - "head", - "base" + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } } }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" + "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" + ] + } + ] + }, + "temp_clone_token": { + "type": [ + "string", + "null" + ] + }, + "allow_squash_merge": { + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "type": "boolean", + "examples": [ + false + ] + }, + "allow_merge_commit": { + "type": "boolean", + "examples": [ + true + ] + }, + "allow_update_branch": { + "type": "boolean", + "examples": [ + true + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "examples": [ + false + ] + }, + "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).", + "examples": [ + "PR_TITLE" + ] + }, + "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.", + "examples": [ + "PR_BODY" + ] + }, + "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).", + "examples": [ + "PR_TITLE" + ] + }, + "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.", + "examples": [ + "PR_BODY" + ] + }, + "allow_forking": { + "type": "boolean", + "examples": [ + true + ] + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "subscribers_count": { + "type": "integer", + "examples": [ + 42 + ] + }, + "network_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } }, - "actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - "triggering_actor": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "parent": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "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" + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "source": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "forks": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "anonymous_access_enabled": { + "description": "Whether anonymous git access is allowed.", + "default": true, + "type": "boolean" + }, + "code_of_conduct": { + "title": "Code Of Conduct Simple", + "description": "Code of Conduct Simple", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/github/docs/community/code_of_conduct" + ] + }, + "key": { + "type": "string", + "examples": [ + "citizen_code_of_conduct" + ] + }, + "name": { + "type": "string", + "examples": [ + "Citizen Code of Conduct" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md" + ] + } + }, + "required": [ + "url", + "key", + "name", + "html_url" + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "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", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "has_discussions", + "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", + "network_count", + "subscribers_count" + ] + }, + "examples": { + "default-response": { + "summary": "Default response", + "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}", + "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", + "forks_count": 9, + "forks": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "open_issues": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "has_discussions": false, + "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": { + "pull": true, + "push": false, + "admin": false + }, + "allow_rebase_merge": true, + "template_repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World-Template", + "full_name": "octocat/Hello-World-Template", + "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-Template", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World-Template", + "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World-Template.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World-Template.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World-Template.git", + "mirror_url": "git:git.example.com/octocat/Hello-World-Template", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World-Template", + "homepage": "https://github.com", + "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, + "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", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "allow_forking": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "spdx_id": "MIT", + "url": "https://api.github.com/licenses/mit", + "node_id": "MDc6TGljZW5zZW1pdA==" + }, + "organization": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "Organization", + "site_admin": false + }, + "parent": { + "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, + "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://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + }, + "source": { + "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", + "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, + "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://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1, + "security_and_analysis": { + "advanced_security": { + "status": "enabled" + }, + "secret_scanning": { + "status": "enabled" + }, + "secret_scanning_push_protection": { + "status": "disabled" + }, + "secret_scanning_non_provider_patterns": { + "status": "disabled" + } + } + } + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "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" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + } + }, + "patch": { + "summary": "Update a repository", + "description": "**Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/repos/repos#replace-all-repository-topics) endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/update", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#update-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": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository." + }, + "description": { + "type": "string", + "description": "A short description of the repository." + }, + "homepage": { + "type": "string", + "description": "A URL with more information about the repository." + }, + "private": { + "type": "boolean", + "description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", + "default": false + }, + "visibility": { + "type": "string", + "description": "The visibility of the repository.", + "enum": [ + "public", + "private" + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "description": "Specify which security and analysis features to enable or disable for the repository.\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\nFor example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request:\n`{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }`.\n\nYou can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request.", + "properties": { + "advanced_security": { + "type": "object", + "description": "Use the `status` property to enable or disable GitHub Advanced Security for this repository.\nFor more information, see \"[About GitHub Advanced\nSecurity](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.", + "properties": { + "status": { + "type": "string", + "description": "Can be `enabled` or `disabled`." + } + } + }, + "code_security": { + "type": "object", + "description": "Use the `status` property to enable or disable GitHub Code Security for this repository.", + "properties": { + "status": { + "type": "string", + "description": "Can be `enabled` or `disabled`." + } + } + }, + "secret_scanning": { + "type": "object", + "description": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", + "properties": { + "status": { + "type": "string", + "description": "Can be `enabled` or `disabled`." + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "description": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"", + "properties": { + "status": { + "type": "string", + "description": "Can be `enabled` or `disabled`." + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "description": "Use the `status` property to enable or disable secret scanning AI detection for this repository. For more information, see \"[Responsible detection of generic secrets with AI](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/generic-secret-detection/responsible-ai-generic-secrets).\"", + "properties": { + "status": { + "type": "string", + "description": "Can be `enabled` or `disabled`." + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "description": "Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. For more information, see \"[Supported secret scanning patterns](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"", + "properties": { + "status": { + "type": "string", + "description": "Can be `enabled` or `disabled`." + } + } + } + } + }, + "has_issues": { + "type": "boolean", + "description": "Either `true` to enable issues for this repository or `false` to disable them.", + "default": true + }, + "has_projects": { + "type": "boolean", + "description": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", + "default": true + }, + "has_wiki": { + "type": "boolean", + "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", + "default": true + }, + "is_template": { + "type": "boolean", + "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", + "default": false + }, + "default_branch": { + "type": "string", + "description": "Updates the default branch for this repository." + }, + "allow_squash_merge": { + "type": "boolean", + "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", + "default": true + }, + "allow_merge_commit": { + "type": "boolean", + "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", + "default": true + }, + "allow_rebase_merge": { + "type": "boolean", + "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", + "default": true + }, + "allow_auto_merge": { + "type": "boolean", + "description": "Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge.", + "default": false + }, + "delete_branch_on_merge": { + "type": "boolean", + "description": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", + "default": false + }, + "allow_update_branch": { + "type": "boolean", + "description": "Either `true` to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise.", + "default": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **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": "Required when using `squash_merge_commit_message`.\n\nThe 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": "Required when using `merge_commit_message`.\n\nThe 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." + }, + "archived": { + "type": "boolean", + "description": "Whether to archive this repository. `false` will unarchive a previously archived repository.", + "default": false + }, + "allow_forking": { + "type": "boolean", + "description": "Either `true` to allow private forks, or `false` to prevent private forks.", + "default": false + }, + "web_commit_signoff_required": { + "type": "boolean", + "description": "Either `true` to require contributors to sign off on web-based commits, or `false` to not require contributors to sign off on web-based commits.", + "default": false + } + } + }, + "examples": { + "default": { + "value": { + "name": "Hello-World", + "description": "This is your first repository", + "homepage": "https://github.com", + "private": true, + "has_issues": true, + "has_projects": true, + "has_wiki": true + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Full Repository", + "description": "Full Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "octocat", + "atom", + "electron", + "API" + ] + }, + "has_issues": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "type": "string", + "examples": [ + "public" + ] + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "allow_rebase_merge": { + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + } + ] + }, + "temp_clone_token": { + "type": [ + "string", + "null" + ] + }, + "allow_squash_merge": { + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "type": "boolean", + "examples": [ + false + ] + }, + "allow_merge_commit": { + "type": "boolean", + "examples": [ + true + ] + }, + "allow_update_branch": { + "type": "boolean", + "examples": [ + true + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "examples": [ + false + ] + }, + "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).", + "examples": [ + "PR_TITLE" + ] + }, + "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.", + "examples": [ + "PR_BODY" + ] + }, + "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).", + "examples": [ + "PR_TITLE" + ] + }, + "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.", + "examples": [ + "PR_BODY" + ] + }, + "allow_forking": { + "type": "boolean", + "examples": [ + true + ] + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "subscribers_count": { + "type": "integer", + "examples": [ + 42 + ] + }, + "network_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "parent": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "source": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "forks": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "anonymous_access_enabled": { + "description": "Whether anonymous git access is allowed.", + "default": true, + "type": "boolean" + }, + "code_of_conduct": { + "title": "Code Of Conduct Simple", + "description": "Code of Conduct Simple", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/github/docs/community/code_of_conduct" + ] + }, + "key": { + "type": "string", + "examples": [ + "citizen_code_of_conduct" + ] + }, + "name": { + "type": "string", + "examples": [ + "Citizen Code of Conduct" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md" + ] + } + }, + "required": [ + "url", + "key", + "name", + "html_url" + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "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", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "has_discussions", + "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", + "network_count", + "subscribers_count" + ] + }, + "examples": { + "default": { + "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}", + "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", + "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" + }, + "language": null, + "forks_count": 9, + "forks": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "open_issues": 0, + "is_template": false, + "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": { + "pull": true, + "push": false, + "admin": false + }, + "allow_rebase_merge": true, + "template_repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World-Template", + "full_name": "octocat/Hello-World-Template", + "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-Template", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World-Template", + "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World-Template.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World-Template.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World-Template.git", + "mirror_url": "git:git.example.com/octocat/Hello-World-Template", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World-Template", + "homepage": "https://github.com", + "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, + "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", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "allow_forking": true, + "web_commit_signoff_required": false, + "subscribers_count": 42, + "network_count": 0, + "organization": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "Organization", + "site_admin": false + }, + "parent": { + "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, + "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://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + }, + "source": { + "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, + "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://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + } + } + } + } + } + }, + "307": { + "description": "Temporary Redirect", + "content": { + "application/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" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/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": "repos", + "subcategory": "repos" + } + }, + "delete": { + "summary": "Delete a repository", + "description": "Deleting a repository requires admin access.\n\nIf an organization owner has configured the organization to prevent members from deleting organization-owned\nrepositories, you will get a `403 Forbidden` response.\n\nOAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/delete", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#delete-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" + }, + "403": { + "description": "If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response:", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Organization members cannot delete repositories.", + "documentation_url": "https://docs.github.com/rest/repos/repos#delete-a-repository" + } + } + } + } + } + }, + "307": { + "description": "Temporary Redirect", + "content": { + "application/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" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + } + } + }, + "/repos/{owner}/{repo}/actions/artifacts": { + "get": { + "summary": "List artifacts for a repository", + "description": "Lists all artifacts for a repository.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "actions" + ], + "operationId": "actions/list-artifacts-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/artifacts#list-artifacts-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 + } + }, + { + "name": "name", + "description": "The name field of an artifact. When specified, only artifacts with this name will be returned.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "artifacts" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "artifacts": { + "type": "array", + "items": { + "title": "Artifact", + "description": "An artifact", + "type": "object", + "properties": { + "id": { + "type": "integer", + "examples": [ + 5 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOkNoZWNrU3VpdGU1" + ] + }, + "name": { + "description": "The name of the artifact.", + "type": "string", + "examples": [ + "AdventureWorks.Framework" + ] + }, + "size_in_bytes": { + "description": "The size in bytes of the artifact.", + "type": "integer", + "examples": [ + 12345 + ] + }, + "url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/github/hello-world/actions/artifacts/5" + ] + }, + "archive_download_url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip" + ] + }, + "expired": { + "description": "Whether or not the artifact has expired.", + "type": "boolean" + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "expires_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "digest": { + "type": [ + "string", + "null" + ], + "description": "The SHA256 digest of the artifact. This field will only be populated on artifacts uploaded with upload-artifact v4 or newer. For older versions, this field will be null.", + "examples": [ + "sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c" + ] + }, + "workflow_run": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "examples": [ + 10 + ] + }, + "repository_id": { + "type": "integer", + "examples": [ + 42 + ] + }, + "head_repository_id": { + "type": "integer", + "examples": [ + 42 + ] + }, + "head_branch": { + "type": "string", + "examples": [ + "main" + ] + }, + "head_sha": { + "type": "string", + "examples": [ + "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" + ] + } + } + } + }, + "required": [ + "id", + "node_id", + "name", + "size_in_bytes", + "url", + "archive_download_url", + "expired", + "created_at", + "expires_at", + "updated_at" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "artifacts": [ + { + "id": 11, + "node_id": "MDg6QXJ0aWZhY3QxMQ==", + "name": "Rails", + "size_in_bytes": 556, + "url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11", + "archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip", + "expired": false, + "created_at": "2020-01-10T14:59:22Z", + "expires_at": "2020-03-21T14:59:22Z", + "updated_at": "2020-02-21T14:59:22Z", + "digest": "sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c", + "workflow_run": { + "id": 2332938, + "repository_id": 1296269, + "head_repository_id": 1296269, + "head_branch": "main", + "head_sha": "328faa0536e6fef19753d9d91dc96a9931694ce3" + } + }, + { + "id": 13, + "node_id": "MDg6QXJ0aWZhY3QxMw==", + "name": "Test output", + "size_in_bytes": 453, + "url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13", + "archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13/zip", + "expired": false, + "created_at": "2020-01-10T14:59:22Z", + "expires_at": "2020-03-21T14:59:22Z", + "updated_at": "2020-02-21T14:59:22Z", + "digest": "sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c", + "workflow_run": { + "id": 2332942, + "repository_id": 1296269, + "head_repository_id": 1296269, + "head_branch": "main", + "head_sha": "178f4f6090b3fccad4a65b3e83d076a622d59652" + } + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "artifacts" + } + } + }, + "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}": { + "get": { + "summary": "Get an artifact", + "description": "Gets a specific artifact for a workflow run.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-artifact", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/artifacts#get-an-artifact" + }, + "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": "artifact_id", + "description": "The unique identifier of the artifact.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Artifact", + "description": "An artifact", + "type": "object", + "properties": { + "id": { + "type": "integer", + "examples": [ + 5 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOkNoZWNrU3VpdGU1" + ] + }, + "name": { + "description": "The name of the artifact.", + "type": "string", + "examples": [ + "AdventureWorks.Framework" + ] + }, + "size_in_bytes": { + "description": "The size in bytes of the artifact.", + "type": "integer", + "examples": [ + 12345 + ] + }, + "url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/github/hello-world/actions/artifacts/5" + ] + }, + "archive_download_url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip" + ] + }, + "expired": { + "description": "Whether or not the artifact has expired.", + "type": "boolean" + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "expires_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "digest": { + "type": [ + "string", + "null" + ], + "description": "The SHA256 digest of the artifact. This field will only be populated on artifacts uploaded with upload-artifact v4 or newer. For older versions, this field will be null.", + "examples": [ + "sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c" + ] + }, + "workflow_run": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "examples": [ + 10 + ] + }, + "repository_id": { + "type": "integer", + "examples": [ + 42 + ] + }, + "head_repository_id": { + "type": "integer", + "examples": [ + 42 + ] + }, + "head_branch": { + "type": "string", + "examples": [ + "main" + ] + }, + "head_sha": { + "type": "string", + "examples": [ + "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" + ] + } + } + } + }, + "required": [ + "id", + "node_id", + "name", + "size_in_bytes", + "url", + "archive_download_url", + "expired", + "created_at", + "expires_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 11, + "node_id": "MDg6QXJ0aWZhY3QxMQ==", + "name": "Rails", + "size_in_bytes": 556, + "url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11", + "archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip", + "expired": false, + "created_at": "2020-01-10T14:59:22Z", + "expires_at": "2020-01-21T14:59:22Z", + "updated_at": "2020-01-21T14:59:22Z", + "digest": "sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c", + "workflow_run": { + "id": 2332938, + "repository_id": 1296269, + "head_repository_id": 1296269, + "head_branch": "main", + "head_sha": "328faa0536e6fef19753d9d91dc96a9931694ce3" + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "artifacts" + } + }, + "delete": { + "summary": "Delete an artifact", + "description": "Deletes an artifact for a workflow run.\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-artifact", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/artifacts#delete-an-artifact" + }, + "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": "artifact_id", + "description": "The unique identifier of the artifact.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "artifacts" + } + } + }, + "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}": { + "get": { + "summary": "Download an artifact", + "description": "Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in\nthe response header to find the URL for the download. The `:archive_format` must be `zip`.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/download-artifact", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/artifacts#download-an-artifact" + }, + "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": "artifact_id", + "description": "The unique identifier of the artifact.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "archive_format", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "302": { + "description": "Response", + "headers": { + "Location": { + "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": { + "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": "actions", + "subcategory": "artifacts" + } + } + }, + "/repos/{owner}/{repo}/actions/cache/usage": { + "get": { + "summary": "Get GitHub Actions cache usage for a repository", + "description": "Gets GitHub Actions cache usage for a repository.\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\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-usage", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-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": { + "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", + "examples": [ + "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", + "examples": [ + 2322142 + ] + }, + "active_caches_count": { + "description": "The number of active caches in the repository.", + "type": "integer", + "examples": [ + 3 + ] + } + }, + "required": [ + "full_name", + "active_caches_size_in_bytes", + "active_caches_count" + ] + }, + "examples": { + "default": { + "value": { + "full_name": "octo-org/Hello-World", + "active_caches_size_in_bytes": 2322142, + "active_caches_count": 3 + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, + "/repos/{owner}/{repo}/actions/caches": { + "get": { + "summary": "List GitHub Actions caches for a repository", + "description": "Lists the GitHub Actions caches for a repository.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-list", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#list-github-actions-caches-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 + } + }, + { + "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 a pull request use `refs/pull//merge`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "key", + "description": "An explicit key or prefix for identifying the cache", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "sort", + "description": "The property to sort the results by. `created_at` means when the cache was created. `last_accessed_at` means when the cache was last accessed. `size_in_bytes` is the size of the cache in bytes.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created_at", + "last_accessed_at", + "size_in_bytes" + ], + "default": "last_accessed_at" + } + }, + { + "name": "direction", + "description": "The direction to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Repository actions caches", + "description": "Repository actions caches", + "type": "object", + "properties": { + "total_count": { + "description": "Total number of caches", + "type": "integer", + "examples": [ + 2 + ] + }, + "actions_caches": { + "description": "Array of caches", + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "examples": [ + 2 + ] + }, + "ref": { + "type": "string", + "examples": [ + "refs/heads/main" + ] + }, + "key": { + "type": "string", + "examples": [ + "Linux-node-958aff96db2d75d67787d1e634ae70b659de937b" + ] + }, + "version": { + "type": "string", + "examples": [ + "73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0" + ] + }, + "last_accessed_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2019-01-24T22:45:36.000Z" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2019-01-24T22:45:36.000Z" + ] + }, + "size_in_bytes": { + "type": "integer", + "examples": [ + 1024 + ] + } + } + } + } + }, + "required": [ + "total_count", + "actions_caches" + ] + }, + "examples": { + "default": { + "value": { + "total_count": 1, + "actions_caches": [ + { + "id": 505, + "ref": "refs/heads/main", + "key": "Linux-node-958aff96db2d75d67787d1e634ae70b659de937b", + "version": "73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0", + "last_accessed_at": "2019-01-24T22:45:36.000Z", + "created_at": "2019-01-24T22:45:36.000Z", + "size_in_bytes": 1024 + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "cache" + } + }, + "delete": { + "summary": "Delete GitHub Actions caches for a repository (using a cache key)", + "description": "Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-actions-cache-by-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key" + }, + "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": "key", + "description": "A key for identifying the cache.", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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 a pull request use `refs/pull//merge`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Repository actions caches", + "description": "Repository actions caches", + "type": "object", + "properties": { + "total_count": { + "description": "Total number of caches", + "type": "integer", + "examples": [ + 2 + ] + }, + "actions_caches": { + "description": "Array of caches", + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "examples": [ + 2 + ] + }, + "ref": { + "type": "string", + "examples": [ + "refs/heads/main" + ] + }, + "key": { + "type": "string", + "examples": [ + "Linux-node-958aff96db2d75d67787d1e634ae70b659de937b" + ] + }, + "version": { + "type": "string", + "examples": [ + "73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0" + ] + }, + "last_accessed_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2019-01-24T22:45:36.000Z" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2019-01-24T22:45:36.000Z" + ] + }, + "size_in_bytes": { + "type": "integer", + "examples": [ + 1024 + ] + } + } + } + } + }, + "required": [ + "total_count", + "actions_caches" + ] + }, + "examples": { + "default": { + "value": { + "total_count": 1, + "actions_caches": [ + { + "id": 505, + "ref": "refs/heads/main", + "key": "Linux-node-958aff96db2d75d67787d1e634ae70b659de937b", + "version": "73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0", + "last_accessed_at": "2019-01-24T22:45:36.000Z", + "created_at": "2019-01-24T22:45:36.000Z", + "size_in_bytes": 1024 + } + ] + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, + "/repos/{owner}/{repo}/actions/caches/{cache_id}": { + "delete": { + "summary": "Delete a GitHub Actions cache for a repository (using a cache ID)", + "description": "Deletes a GitHub Actions cache for a repository, using a cache ID.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-actions-cache-by-id", + "externalDocs": { + "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": [ + { + "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": "cache_id", + "description": "The unique identifier of the GitHub Actions cache.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, + "/repos/{owner}/{repo}/actions/jobs/{job_id}": { + "get": { + "summary": "Get a job for a workflow run", + "description": "Gets a specific job in a workflow run.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-job-for-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run" + }, + "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": "job_id", + "description": "The unique identifier of the job.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Job", + "description": "Information of a job execution in a workflow run", + "type": "object", + "properties": { + "id": { + "description": "The id of the job.", + "type": "integer", + "examples": [ + 21 + ] + }, + "run_id": { + "description": "The id of the associated workflow run.", + "type": "integer", + "examples": [ + 5 + ] + }, + "run_url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/github/hello-world/actions/runs/5" + ] + }, + "run_attempt": { + "type": "integer", + "description": "Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run.", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDg6Q2hlY2tSdW40" + ] + }, + "head_sha": { + "description": "The SHA of the commit that is being run.", + "type": "string", + "examples": [ + "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" + ] + }, + "url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/github/hello-world/actions/jobs/21" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "examples": [ + "https://github.com/github/hello-world/runs/4" + ] + }, + "status": { + "description": "The phase of the lifecycle that the job is currently in.", + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed", + "waiting", + "requested", + "pending" + ], + "examples": [ + "queued" + ] + }, + "conclusion": { + "description": "The outcome of the job.", + "type": [ + "string", + "null" + ], + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + null + ], + "examples": [ + "success" + ] + }, + "created_at": { + "description": "The time that the job created, in ISO 8601 format.", + "format": "date-time", + "type": "string", + "examples": [ + "2019-08-08T08:00:00-07:00" + ] + }, + "started_at": { + "description": "The time that the job started, in ISO 8601 format.", + "format": "date-time", + "type": "string", + "examples": [ + "2019-08-08T08:00:00-07:00" + ] + }, + "completed_at": { + "description": "The time that the job finished, in ISO 8601 format.", + "format": "date-time", + "type": [ + "string", + "null" + ], + "examples": [ + "2019-08-08T08:00:00-07:00" + ] + }, + "name": { + "description": "The name of the job.", + "type": "string", + "examples": [ + "test-coverage" + ] + }, + "steps": { + "description": "Steps in this job.", + "type": "array", + "items": { + "type": "object", + "required": [ + "name", + "status", + "conclusion", + "number" + ], + "properties": { + "status": { + "description": "The phase of the lifecycle that the job is currently in.", + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed" + ], + "examples": [ + "queued" + ] + }, + "conclusion": { + "description": "The outcome of the job.", + "type": [ + "string", + "null" + ], + "examples": [ + "success" + ] + }, + "name": { + "description": "The name of the job.", + "type": "string", + "examples": [ + "test-coverage" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "started_at": { + "description": "The time that the step started, in ISO 8601 format.", + "format": "date-time", + "type": [ + "string", + "null" + ], + "examples": [ + "2019-08-08T08:00:00-07:00" + ] + }, + "completed_at": { + "description": "The time that the job finished, in ISO 8601 format.", + "format": "date-time", + "type": [ + "string", + "null" + ], + "examples": [ + "2019-08-08T08:00:00-07:00" + ] + } + } + } + }, + "check_run_url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/github/hello-world/check-runs/4" + ] + }, + "labels": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Labels for the workflow job. Specified by the \"runs_on\" attribute in the action's workflow file.", + "examples": [ + "self-hosted", + "foo", + "bar" + ] + }, + "runner_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", + "examples": [ + 1 + ] + }, + "runner_name": { + "type": [ + "string", + "null" + ], + "description": "The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", + "examples": [ + "my runner" + ] + }, + "runner_group_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", + "examples": [ + 2 + ] + }, + "runner_group_name": { + "type": [ + "string", + "null" + ], + "description": "The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)", + "examples": [ + "my runner group" + ] + }, + "workflow_name": { + "type": [ + "string", + "null" + ], + "description": "The name of the workflow.", + "examples": [ + "Build" + ] + }, + "head_branch": { + "type": [ + "string", + "null" + ], + "description": "The name of the current branch.", + "examples": [ + "main" + ] + } + }, + "required": [ + "id", + "node_id", + "run_id", + "run_url", + "head_sha", + "workflow_name", + "head_branch", + "name", + "url", + "html_url", + "status", + "conclusion", + "started_at", + "completed_at", + "check_run_url", + "labels", + "runner_id", + "runner_name", + "runner_group_id", + "runner_group_name", + "created_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 399444496, + "run_id": 29679449, + "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449", + "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==", + "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0", + "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496", + "html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496", + "status": "completed", + "conclusion": "success", + "started_at": "2020-01-20T17:42:40Z", + "completed_at": "2020-01-20T17:44:39Z", + "name": "build", + "steps": [ + { + "name": "Set up job", + "status": "completed", + "conclusion": "success", + "number": 1, + "started_at": "2020-01-20T09:42:40.000-08:00", + "completed_at": "2020-01-20T09:42:41.000-08:00" + }, + { + "name": "Run actions/checkout@v2", + "status": "completed", + "conclusion": "success", + "number": 2, + "started_at": "2020-01-20T09:42:41.000-08:00", + "completed_at": "2020-01-20T09:42:45.000-08:00" + }, + { + "name": "Set up Ruby", + "status": "completed", + "conclusion": "success", + "number": 3, + "started_at": "2020-01-20T09:42:45.000-08:00", + "completed_at": "2020-01-20T09:42:45.000-08:00" + }, + { + "name": "Run actions/cache@v3", + "status": "completed", + "conclusion": "success", + "number": 4, + "started_at": "2020-01-20T09:42:45.000-08:00", + "completed_at": "2020-01-20T09:42:48.000-08:00" + }, + { + "name": "Install Bundler", + "status": "completed", + "conclusion": "success", + "number": 5, + "started_at": "2020-01-20T09:42:48.000-08:00", + "completed_at": "2020-01-20T09:42:52.000-08:00" + }, + { + "name": "Install Gems", + "status": "completed", + "conclusion": "success", + "number": 6, + "started_at": "2020-01-20T09:42:52.000-08:00", + "completed_at": "2020-01-20T09:42:53.000-08:00" + }, + { + "name": "Run Tests", + "status": "completed", + "conclusion": "success", + "number": 7, + "started_at": "2020-01-20T09:42:53.000-08:00", + "completed_at": "2020-01-20T09:42:59.000-08:00" + }, + { + "name": "Deploy to Heroku", + "status": "completed", + "conclusion": "success", + "number": 8, + "started_at": "2020-01-20T09:42:59.000-08:00", + "completed_at": "2020-01-20T09:44:39.000-08:00" + }, + { + "name": "Post actions/cache@v3", + "status": "completed", + "conclusion": "success", + "number": 16, + "started_at": "2020-01-20T09:44:39.000-08:00", + "completed_at": "2020-01-20T09:44:39.000-08:00" + }, + { + "name": "Complete job", + "status": "completed", + "conclusion": "success", + "number": 17, + "started_at": "2020-01-20T09:44:39.000-08:00", + "completed_at": "2020-01-20T09:44:39.000-08:00" + } + ], + "check_run_url": "https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496", + "labels": [ + "self-hosted", + "foo", + "bar" + ], + "runner_id": 1, + "runner_name": "my runner", + "runner_group_id": 2, + "runner_group_name": "my runner group", + "workflow_name": "CI", + "head_branch": "main" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflow-jobs" + } + } + }, + "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs": { + "get": { + "summary": "Download job logs for a workflow run", + "description": "Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look\nfor `Location:` in the response header to find the URL for the download.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/download-job-logs-for-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run" + }, + "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": "job_id", + "description": "The unique identifier of the job.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "302": { + "description": "Response", + "headers": { + "Location": { + "example": "https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/jobs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflow-jobs" + } + } + }, + "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun": { + "post": { + "summary": "Re-run a job from a workflow run", + "description": "Re-run a job and its dependent jobs in a workflow run.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/re-run-job-for-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run" + }, + "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": "job_id", + "description": "The unique identifier of the job.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": [ + "object", + "null" + ], + "properties": { + "enable_debug_logging": { + "type": "boolean", + "default": false, + "description": "Whether to enable debug logging for the re-run." + } + } + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "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": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/oidc/customization/sub": { + "get": { + "summary": "Get the customization template for an OIDC subject claim for a repository", + "description": "Gets the customization template for an OpenID Connect (OIDC) subject claim.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-custom-oidc-sub-claim-for-repo", + "externalDocs": { + "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": [ + { + "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": "Status response", + "content": { + "application/json": { + "schema": { + "title": "Actions OIDC subject customization for a repository", + "description": "Actions OIDC subject customization for a repository", + "type": "object", + "properties": { + "use_default": { + "description": "Whether to use the default template or not. If `true`, the `include_claim_keys` field is ignored.", + "type": "boolean" + }, + "include_claim_keys": { + "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "use_default" + ] + }, + "examples": { + "default": { + "value": { + "use_default": false, + "include_claim_keys": [ + "repo", + "context" + ] + } + } + } + } + } + }, + "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "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": { + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "oidc" + } + }, + "put": { + "summary": "Set the customization template for an OIDC subject claim for a repository", + "description": "Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-custom-oidc-sub-claim-for-repo", + "externalDocs": { + "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": [ + { + "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": { + "title": "Actions OIDC subject customization for a repository", + "description": "Actions OIDC subject customization for a repository", + "type": "object", + "required": [ + "use_default" + ], + "properties": { + "use_default": { + "description": "Whether to use the default template or not. If `true`, the `include_claim_keys` field is ignored.", + "type": "boolean" + }, + "include_claim_keys": { + "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": { + "use_default": false, + "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" + } + } + } + } + } + }, + "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "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", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "oidc" + } + } + }, + "/repos/{owner}/{repo}/actions/organization-secrets": { + "get": { + "summary": "List repository organization secrets", + "description": "Lists all organization secrets shared with a repository without revealing their encrypted\nvalues.\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 `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-repo-organization-secrets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets" + }, + "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": "object", + "required": [ + "total_count", + "secrets" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "secrets": { + "type": "array", + "items": { + "title": "Actions Secret", + "description": "Set secrets for GitHub Actions.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret.", + "type": "string", + "examples": [ + "SECRET_TOKEN" + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "name", + "created_at", + "updated_at" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "secrets": [ + { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + }, + { + "name": "GIST_ID", + "created_at": "2020-01-10T10:59:22Z", + "updated_at": "2020-01-11T11:59:22Z" + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + } + } + }, + "/repos/{owner}/{repo}/actions/organization-variables": { + "get": { + "summary": "List repository organization variables", + "description": "Lists all organization variables shared with a repository.\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 `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-repo-organization-variables", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/variables#list-repository-organization-variables" + }, + "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 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", + "type": "object", + "properties": { + "name": { + "description": "The name of the variable.", + "type": "string", + "examples": [ + "USERNAME" + ] + }, + "value": { + "description": "The value of the variable.", + "type": "string", + "examples": [ + "octocat" + ] + }, + "created_at": { + "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time", + "examples": [ + "2019-01-24T22:45:36.000Z" + ] + }, + "updated_at": { + "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time", + "examples": [ + "2019-01-24T22:45:36.000Z" + ] + } + }, + "required": [ + "name", + "value", + "created_at", + "updated_at" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "variables": [ + { + "name": "USERNAME", + "value": "octocat", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + }, + { + "name": "EMAIL", + "value": "octocat@github.com", + "created_at": "2020-01-10T10:59:22Z", + "updated_at": "2020-01-11T11:59:22Z" + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + } + }, + "/repos/{owner}/{repo}/actions/permissions": { + "get": { + "summary": "Get GitHub Actions permissions for a repository", + "description": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/get-github-actions-permissions-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-github-actions-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": { + "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" + ] + }, + "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" + ] + }, + "examples": { + "default": { + "value": { + "enabled": true, + "allowed_actions": "selected", + "selected_actions_url": "https://api.github.com/repositories/42/actions/permissions/selected-actions" + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set GitHub Actions permissions for a repository", + "description": "Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/set-github-actions-permissions-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-github-actions-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" + } + }, + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "approval_policy": { + "type": "string", + "enum": [ + "first_time_contributors_new_to_github", + "first_time_contributors", + "all_external_contributors" + ], + "description": "The policy that controls when fork PR workflows require approval from a maintainer." + } + }, + "required": [ + "approval_policy" + ] + }, + "examples": { + "default": { + "summary": "Set approval policy to first time contributors", + "value": { + "approval_policy": "first_time_contributors" + } + } + } + } + } + }, + "x-github": { + "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": { + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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", + "description": "Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/get-allowed-actions-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-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": { + "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": { + "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 a repository", + "description": "Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/set-allowed-actions-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-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" + } + }, + "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" + } + } + }, + "/repos/{owner}/{repo}/actions/permissions/workflow": { + "get": { + "summary": "Get default workflow permissions for a repository", + "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository,\nas well as if GitHub Actions can submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-github-actions-default-workflow-permissions-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-default-workflow-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": { + "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 a repository", + "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions\ncan submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-github-actions-default-workflow-permissions-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-default-workflow-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": "Success response" + }, + "409": { + "description": "Conflict response when changing a setting is prevented by the owning organization" + } + }, + "requestBody": { + "required": true, + "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" + } + } + }, + "/repos/{owner}/{repo}/actions/runners": { + "get": { + "summary": "List self-hosted runners for a repository", + "description": "Lists all self-hosted runners configured in a repository.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-self-hosted-runners-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-a-repository" + }, + "parameters": [ + { + "name": "name", + "description": "The name of a self-hosted runner.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "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": "object", + "required": [ + "total_count", + "runners" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "runners": { + "type": "array", + "items": { + "title": "Self hosted runners", + "description": "A self hosted runner", + "type": "object", + "properties": { + "id": { + "description": "The ID of the runner.", + "type": "integer", + "examples": [ + 5 + ] + }, + "runner_group_id": { + "description": "The ID of the runner group.", + "type": "integer", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the runner.", + "type": "string", + "examples": [ + "iMac" + ] + }, + "os": { + "description": "The Operating System of the runner.", + "type": "string", + "examples": [ + "macos" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "examples": [ + "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": { + "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" + } + ] + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + } + } + }, + "/repos/{owner}/{repo}/actions/runners/downloads": { + "get": { + "summary": "List runner applications for a repository", + "description": "Lists binaries for the runner application that you can download and run.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-runner-applications-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-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": "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" + } + }, + "required": [ + "os", + "architecture", + "download_url", + "filename" + ] + } + }, + "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" + } + ] + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + } + } + }, + "/repos/{owner}/{repo}/actions/runners/generate-jitconfig": { + "post": { + "summary": "Create configuration for a just-in-time runner for a repository", + "description": "Generates a configuration that can be passed to the runner application at startup.\n\nThe authenticated user must have admin access to the repository.\n\nOAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/generate-runner-jitconfig-for-repo", + "externalDocs": { + "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": [ + { + "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": [ + "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": { + "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" + } + } + }, + "examples": { + "default": { + "value": { + "name": "New runner", + "runner_group_id": 1, + "labels": [ + "self-hosted", + "X64", + "macOS", + "no-gpu" + ], + "work_folder": "_work" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "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", + "examples": [ + 5 + ] + }, + "runner_group_id": { + "description": "The ID of the runner group.", + "type": "integer", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the runner.", + "type": "string", + "examples": [ + "iMac" + ] + }, + "os": { + "description": "The Operating System of the runner.", + "type": "string", + "examples": [ + "macos" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "examples": [ + "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": { + "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" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/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" + } + } + } + } + } + } + }, + "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": "self-hosted-runners" + } + } + }, + "/repos/{owner}/{repo}/actions/runners/registration-token": { + "post": { + "summary": "Create a registration token for a repository", + "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 repository to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/create-registration-token-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-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": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Authentication Token", + "description": "Authentication Token", + "type": "object", + "properties": { + "token": { + "description": "The token used for authentication", + "type": "string", + "examples": [ + "v1.1f699f1069f60xxx" + ] + }, + "expires_at": { + "description": "The time this token expires", + "type": "string", + "format": "date-time", + "examples": [ + "2016-07-11T22:14:10Z" + ] + }, + "permissions": { + "type": "object", + "examples": [ + { + "issues": "read", + "deployments": "write" + } + ] + }, + "repositories": { + "description": "The repositories this token has access to", + "type": "array", + "items": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + } + }, + "single_file": { + "type": [ + "string", + "null" + ], + "examples": [ + "config.yaml" + ] + }, + "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" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + } + } + }, + "/repos/{owner}/{repo}/actions/runners/remove-token": { + "post": { + "summary": "Create a remove token for a repository", + "description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. 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 repository to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/create-remove-token-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-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": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Authentication Token", + "description": "Authentication Token", + "type": "object", + "properties": { + "token": { + "description": "The token used for authentication", + "type": "string", + "examples": [ + "v1.1f699f1069f60xxx" + ] + }, + "expires_at": { + "description": "The time this token expires", + "type": "string", + "format": "date-time", + "examples": [ + "2016-07-11T22:14:10Z" + ] + }, + "permissions": { + "type": "object", + "examples": [ + { + "issues": "read", + "deployments": "write" + } + ] + }, + "repositories": { + "description": "The repositories this token has access to", + "type": "array", + "items": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + } + }, + "single_file": { + "type": [ + "string", + "null" + ], + "examples": [ + "config.yaml" + ] + }, + "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" + } + } + }, + "/repos/{owner}/{repo}/actions/runners/{runner_id}": { + "get": { + "summary": "Get a self-hosted runner for a repository", + "description": "Gets a specific self-hosted runner configured in a repository.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-self-hosted-runner-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-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": "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", + "examples": [ + 5 + ] + }, + "runner_group_id": { + "description": "The ID of the runner group.", + "type": "integer", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the runner.", + "type": "string", + "examples": [ + "iMac" + ] + }, + "os": { + "description": "The Operating System of the runner.", + "type": "string", + "examples": [ + "macos" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "examples": [ + "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" + }, + { + "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 a repository", + "description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-self-hosted-runner-from-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-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": "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" + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + } + } + }, + "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels": { + "get": { + "summary": "List labels for a self-hosted runner for a repository", + "description": "Lists all labels for a self-hosted runner configured in a repository.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-labels-for-self-hosted-runner-for-repo", + "externalDocs": { + "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": [ + { + "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": "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": { + "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" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + } + }, + "post": { + "summary": "Add custom labels to a self-hosted runner for a repository", + "description": "Adds custom labels to a self-hosted runner configured in a repository.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/add-custom-labels-to-self-hosted-runner-for-repo", + "externalDocs": { + "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": [ + { + "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": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "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": { + "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" + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + } + }, + "put": { + "summary": "Set custom labels for a self-hosted runner for a repository", + "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-custom-labels-for-self-hosted-runner-for-repo", + "externalDocs": { + "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": [ + { + "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": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "labels" + ], + "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": { + "default": { + "value": { + "labels": [ + "gpu", + "accelerated" + ] + } + } + } + } + } + }, + "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" + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + } + }, + "delete": { + "summary": "Remove all custom labels from a self-hosted runner for a repository", + "description": "Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/remove-all-custom-labels-from-self-hosted-runner-for-repo", + "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-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": "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": { + "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" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + } + } + }, + "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}": { + "delete": { + "summary": "Remove a custom label from a self-hosted runner for a repository", + "description": "Remove a custom label from a self-hosted runner configured\nin a repository. 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 repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/remove-custom-label-from-self-hosted-runner-for-repo", + "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-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": "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", + "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" + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + } + } + }, + "/repos/{owner}/{repo}/actions/runs": { + "get": { + "summary": "List workflow runs for a repository", + "description": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.\n\nThis endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.", + "tags": [ + "actions" + ], + "operationId": "actions/list-workflow-runs-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-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": "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.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "branch", + "description": "Returns workflow runs associated with a branch. Use the name of the branch of the `push`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "event", + "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "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 can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "completed", + "action_required", + "cancelled", + "failure", + "neutral", + "skipped", + "stale", + "success", + "timed_out", + "in_progress", + "queued", + "requested", + "waiting", + "pending" + ] + } + }, + { + "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": "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).\"", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "name": "exclude_pull_requests", + "description": "If `true` pull requests are omitted from the response (empty array).", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": false + } + }, + { + "name": "check_suite_id", + "description": "Returns workflow runs with the `check_suite_id` that you specify.", + "in": "query", + "schema": { + "type": "integer" + } + }, + { + "name": "head_sha", + "description": "Only returns workflow runs that are associated with the specified `head_sha`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "workflow_runs" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "workflow_runs": { + "type": "array", + "items": { + "title": "Workflow Run", + "description": "An invocation of a workflow", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the workflow run.", + "examples": [ + 5 + ] + }, + "name": { + "type": [ + "string", + "null" + ], + "description": "The name of the workflow run.", + "examples": [ + "Build" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOkNoZWNrU3VpdGU1" + ] + }, + "check_suite_id": { + "type": "integer", + "description": "The ID of the associated check suite.", + "examples": [ + 42 + ] + }, + "check_suite_node_id": { + "type": "string", + "description": "The node ID of the associated check suite.", + "examples": [ + "MDEwOkNoZWNrU3VpdGU0Mg==" + ] + }, + "head_branch": { + "type": [ + "string", + "null" + ], + "examples": [ + "master" + ] + }, + "head_sha": { + "description": "The SHA of the head commit that points to the version of the workflow being run.", + "type": "string", + "examples": [ + "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d" + ] + }, + "path": { + "description": "The full path of the workflow", + "type": "string", + "examples": [ + "octocat/octo-repo/.github/workflows/ci.yml@main" + ] + }, + "run_number": { + "type": "integer", + "description": "The auto incrementing run number for the workflow run.", + "examples": [ + 106 + ] + }, + "run_attempt": { + "type": "integer", + "description": "Attempt number of the run, 1 for first attempt and higher if the workflow was re-run.", + "examples": [ + 1 + ] + }, + "referenced_workflows": { + "type": [ + "array", + "null" + ], + "items": { + "title": "Referenced workflow", + "description": "A workflow referenced/reused by the initial caller workflow", + "type": "object", + "properties": { + "path": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "ref": { + "type": "string" + } + }, + "required": [ + "path", + "sha" + ] + } + }, + "event": { + "type": "string", + "examples": [ + "push" + ] + }, + "status": { + "type": [ + "string", + "null" + ], + "examples": [ + "completed" + ] + }, + "conclusion": { + "type": [ + "string", + "null" + ], + "examples": [ + "neutral" + ] + }, + "workflow_id": { + "type": "integer", + "description": "The ID of the parent workflow.", + "examples": [ + 5 + ] + }, + "url": { + "type": "string", + "description": "The URL to the workflow run.", + "examples": [ + "https://api.github.com/repos/github/hello-world/actions/runs/5" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "https://github.com/github/hello-world/suites/4" + ] + }, + "pull_requests": { + "description": "Pull requests that are open with a `head_sha` or `head_branch` that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run.", + "type": [ + "array", + "null" + ], + "items": { + "title": "Pull Request Minimal", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + } + }, + "required": [ + "id", + "number", + "url", + "head", + "base" + ] + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "actor": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "triggering_actor": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, "run_started_at": { @@ -322214,6 +326901,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": [ @@ -326267,7 +330978,956 @@ } ] }, - "parent": { + "parent": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "source": { "title": "Repository", "description": "A repository on GitHub.", "type": "object", @@ -327216,1703 +332876,7230 @@ "updated_at" ] }, - "source": { - "title": "Repository", - "description": "A repository on GitHub.", + "forks": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "anonymous_access_enabled": { + "description": "Whether anonymous git access is allowed.", + "default": true, + "type": "boolean" + }, + "code_of_conduct": { + "title": "Code Of Conduct Simple", + "description": "Code of Conduct Simple", "type": "object", "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", + "url": { + "type": "string", + "format": "uri", "examples": [ - 42 + "https://api.github.com/repos/github/docs/community/code_of_conduct" ] }, - "node_id": { + "key": { "type": "string", "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "citizen_code_of_conduct" ] }, "name": { - "description": "The name of the repository.", "type": "string", "examples": [ - "Team Environment" + "Citizen Code of Conduct" ] }, - "full_name": { - "type": "string", + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", "examples": [ - "octocat/Hello-World" + "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md" ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" + } + }, + "required": [ + "url", + "key", + "name", + "html_url" + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "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" ] } - ] - }, - "forks": { - "type": "integer" + } }, - "permissions": { + "code_security": { "type": "object", "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] } - }, - "required": [ - "admin", - "pull", - "push" - ] + } }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "enum": [ + "enabled", + "disabled" ] - }, - "received_events_url": { + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" + "enum": [ + "enabled", + "disabled" ] - }, - "type": { + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { "type": "string", - "examples": [ - "User" + "enum": [ + "enabled", + "disabled" ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" + "enum": [ + "enabled", + "disabled" ] - }, - "user_view_type": { + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { "type": "string", - "examples": [ - "public" + "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", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "has_discussions", + "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", + "network_count", + "subscribers_count" + ] + }, + "examples": { + "default": { + "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}", + "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", + "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" + }, + "language": null, + "forks_count": 9, + "forks": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "open_issues": 0, + "is_template": false, + "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": { + "pull": true, + "push": false, + "admin": false + }, + "allow_rebase_merge": true, + "template_repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World-Template", + "full_name": "octocat/Hello-World-Template", + "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-Template", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World-Template", + "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World-Template.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World-Template.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World-Template.git", + "mirror_url": "git:git.example.com/octocat/Hello-World-Template", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World-Template", + "homepage": "https://github.com", + "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, + "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", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "allow_forking": true, + "web_commit_signoff_required": false, + "subscribers_count": 42, + "network_count": 0, + "organization": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "Organization", + "site_admin": false + }, + "parent": { + "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, + "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://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + }, + "source": { + "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, + "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://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + } + } + } + } + } + }, + "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "forks" + } + } + }, + "/repos/{owner}/{repo}/git/blobs": { + "post": { + "summary": "Create a blob", + "description": "", + "tags": [ + "git" + ], + "operationId": "git/create-blob", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/git/blobs#create-a-blob" + }, + "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": { + "content": { + "type": "string", + "description": "The new blob's content." + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" + } + }, + "required": [ + "content" + ] + }, + "examples": { + "default": { + "value": { + "content": "Content of the blob", + "encoding": "utf-8" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Short Blob", + "description": "Short Blob", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "sha": { + "type": "string" + } + }, + "required": [ + "url", + "sha" + ] + }, + "examples": { + "default": { + "value": { + "url": "https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15", + "sha": "3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15" + } + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15", + "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" + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "422": { + "description": "Validation failed", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + }, + { + "description": "Repository rule violation was detected", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "status": { + "type": "string" + }, + "metadata": { + "type": "object", + "properties": { + "secret_scanning": { + "type": "object", + "properties": { + "bypass_placeholders": { + "type": "array", + "items": { + "type": "object", + "properties": { + "placeholder_id": { + "description": "The ID of the push protection bypass placeholder. This value is returned on any push protected routes.", + "type": "string" + }, + "token_type": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + ] + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "git", + "subcategory": "blobs" + } + } + }, + "/repos/{owner}/{repo}/git/blobs/{file_sha}": { + "get": { + "summary": "Get a blob", + "description": "The `content` in the response will always be Base64 encoded.\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 blob data.\n- **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified.\n\n**Note** This endpoint supports blobs up to 100 megabytes in size.", + "tags": [ + "git" + ], + "operationId": "git/get-blob", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/git/blobs#get-a-blob" + }, + "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": "file_sha", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Blob", + "description": "Blob", + "type": "object", + "properties": { + "content": { + "type": "string" + }, + "encoding": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "sha": { + "type": "string" + }, + "size": { + "type": [ + "integer", + "null" + ] + }, + "node_id": { + "type": "string" + }, + "highlighted_content": { + "type": "string" + } + }, + "required": [ + "sha", + "url", + "node_id", + "size", + "content", + "encoding" + ] + }, + "examples": { + "default": { + "value": { + "content": "Q29udGVudCBvZiB0aGUgYmxvYg==", + "encoding": "base64", + "url": "https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15", + "sha": "3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15", + "size": 19, + "node_id": "Q29udGVudCBvZiB0aGUgYmxvYg==" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/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" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "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": "git", + "subcategory": "blobs" + } + } + }, + "/repos/{owner}/{repo}/git/commits": { + "post": { + "summary": "Create a commit", + "description": "Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "tags": [ + "git" + ], + "operationId": "git/create-commit", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/git/commits#create-a-commit" + }, + "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": { + "message": { + "type": "string", + "description": "The commit message" + }, + "tree": { + "type": "string", + "description": "The SHA of the tree object this commit points to" + }, + "parents": { + "type": "array", + "description": "The full SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.", + "items": { + "type": "string" + } + }, + "author": { + "type": "object", + "description": "Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details.", + "properties": { + "name": { + "type": "string", + "description": "The name of the author (or committer) of the commit" + }, + "email": { + "type": "string", + "description": "The email of the author (or committer) of the commit" + }, + "date": { + "type": "string", + "format": "date-time", + "description": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." + } + }, + "required": [ + "name", + "email" + ] + }, + "committer": { + "type": "object", + "description": "Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details.", + "properties": { + "name": { + "type": "string", + "description": "The name of the author (or committer) of the commit" + }, + "email": { + "type": "string", + "description": "The email of the author (or committer) of the commit" + }, + "date": { + "type": "string", + "format": "date-time", + "description": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." + } + } + }, + "signature": { + "type": "string", + "description": "The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits." + } + }, + "required": [ + "message", + "tree" + ] + }, + "examples": { + "default": { + "value": { + "message": "my commit message", + "author": { + "name": "Mona Octocat", + "email": "octocat@github.com", + "date": "2008-07-09T16:13:30+12:00" + }, + "parents": [ + "7d1b31e74ee336d15cbd21741bc88a537ed063a0" + ], + "tree": "827efc6d56897b048c772eb4087f854f46256132", + "signature": "-----BEGIN PGP SIGNATURE-----\n\niQIzBAABAQAdFiEESn/54jMNIrGSE6Tp6cQjvhfv7nAFAlnT71cACgkQ6cQjvhfv\n7nCWwA//XVqBKWO0zF+bZl6pggvky3Oc2j1pNFuRWZ29LXpNuD5WUGXGG209B0hI\nDkmcGk19ZKUTnEUJV2Xd0R7AW01S/YSub7OYcgBkI7qUE13FVHN5ln1KvH2all2n\n2+JCV1HcJLEoTjqIFZSSu/sMdhkLQ9/NsmMAzpf/iIM0nQOyU4YRex9eD1bYj6nA\nOQPIDdAuaTQj1gFPHYLzM4zJnCqGdRlg0sOM/zC5apBNzIwlgREatOYQSCfCKV7k\nnrU34X8b9BzQaUx48Qa+Dmfn5KQ8dl27RNeWAqlkuWyv3pUauH9UeYW+KyuJeMkU\n+NyHgAsWFaCFl23kCHThbLStMZOYEnGagrd0hnm1TPS4GJkV4wfYMwnI4KuSlHKB\njHl3Js9vNzEUQipQJbgCgTiWvRJoK3ENwBTMVkKHaqT4x9U4Jk/XZB6Q8MA09ezJ\n3QgiTjTAGcum9E9QiJqMYdWQPWkaBIRRz5cET6HPB48YNXAAUsfmuYsGrnVLYbG+\nUpC6I97VybYHTy2O9XSGoaLeMI9CsFn38ycAxxbWagk5mhclNTP5mezIq6wKSwmr\nX11FW3n1J23fWZn5HJMBsRnUCgzqzX3871IqLYHqRJ/bpZ4h20RhTyPj5c/z7QXp\neSakNQMfbbMcljkha+ZMuVQX1K9aRlVqbmv3ZMWh+OijLYVU2bc=\n=5Io4\n-----END PGP SIGNATURE-----\n" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Git Commit", + "description": "Low-level Git commit operations within a repository", + "type": "object", + "properties": { + "sha": { + "description": "SHA for the commit", + "type": "string", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "author": { + "description": "Identifying information for the git-user", + "type": "object", + "properties": { + "date": { + "description": "Timestamp of the commit", + "format": "date-time", + "type": "string", + "examples": [ + "2014-08-09T08:02:04+12:00" ] }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" + "email": { + "type": "string", + "description": "Git email address of the user", + "examples": [ + "monalisa.octocat@example.com" + ] }, - "html_url": { + "name": { + "description": "Name of the git user", "type": "string", - "format": "uri", "examples": [ - "https://github.com/octocat/Hello-World" + "Monalisa Octocat" + ] + } + }, + "required": [ + "email", + "name", + "date" + ] + }, + "committer": { + "description": "Identifying information for the git-user", + "type": "object", + "properties": { + "date": { + "description": "Timestamp of the commit", + "format": "date-time", + "type": "string", + "examples": [ + "2014-08-09T08:02:04+12:00" ] }, - "description": { - "type": [ - "string", - "null" - ], + "email": { + "type": "string", + "description": "Git email address of the user", "examples": [ - "This your first repo!" + "monalisa.octocat@example.com" ] }, - "fork": { + "name": { + "description": "Name of the git user", + "type": "string", + "examples": [ + "Monalisa Octocat" + ] + } + }, + "required": [ + "email", + "name", + "date" + ] + }, + "message": { + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] + }, + "tree": { + "type": "object", + "properties": { + "sha": { + "description": "SHA for the commit", + "type": "string", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "sha", + "url" + ] + }, + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sha": { + "description": "SHA for the commit", + "type": "string", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "sha", + "url", + "html_url" + ] + } + }, + "verification": { + "type": "object", + "properties": { + "verified": { "type": "boolean" }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] + "reason": { + "type": "string" }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + "signature": { + "type": [ + "string", + "null" ] }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + "payload": { + "type": [ + "string", + "null" ] }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + "verified_at": { + "type": [ + "string", + "null" ] - }, - "comments_url": { + } + }, + "required": [ + "verified", + "reason", + "signature", + "payload", + "verified_at" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "sha", + "node_id", + "url", + "html_url", + "author", + "committer", + "tree", + "message", + "parents", + "verification" + ] + }, + "examples": { + "default": { + "value": { + "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", + "node_id": "MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==", + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd", + "author": { + "date": "2014-11-07T22:01:45Z", + "name": "Monalisa Octocat", + "email": "octocat@github.com" + }, + "committer": { + "date": "2014-11-07T22:01:45Z", + "name": "Monalisa Octocat", + "email": "octocat@github.com" + }, + "message": "my commit message", + "tree": { + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/827efc6d56897b048c772eb4087f854f46256132", + "sha": "827efc6d56897b048c772eb4087f854f46256132" + }, + "parents": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7d1b31e74ee336d15cbd21741bc88a537ed063a0", + "sha": "7d1b31e74ee336d15cbd21741bc88a537ed063a0", + "html_url": "https://github.com/octocat/Hello-World/commit/7d1b31e74ee336d15cbd21741bc88a537ed063a0" + } + ], + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null, + "verified_at": null + }, + "html_url": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" + } + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd", + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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" + } + } + } + } + } + }, + "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": "git", + "subcategory": "commits" + } + } + }, + "/repos/{owner}/{repo}/git/commits/{commit_sha}": { + "get": { + "summary": "Get a commit object", + "description": "Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).\n\nTo get the contents of a commit, see \"[Get a commit](/rest/commits/commits#get-a-commit).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "tags": [ + "git" + ], + "operationId": "git/get-commit", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/git/commits#get-a-commit-object" + }, + "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": "commit_sha", + "description": "The SHA of the commit.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Git Commit", + "description": "Low-level Git commit operations within a repository", + "type": "object", + "properties": { + "sha": { + "description": "SHA for the commit", + "type": "string", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "author": { + "description": "Identifying information for the git-user", + "type": "object", + "properties": { + "date": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + "2014-08-09T08:02:04+12:00" ] }, - "commits_url": { + "email": { "type": "string", + "description": "Git email address of the user", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "monalisa.octocat@example.com" ] }, - "compare_url": { + "name": { + "description": "Name of the git user", "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "Monalisa Octocat" ] - }, - "contents_url": { + } + }, + "required": [ + "email", + "name", + "date" + ] + }, + "committer": { + "description": "Identifying information for the git-user", + "type": "object", + "properties": { + "date": { + "description": "Timestamp of the commit", + "format": "date-time", "type": "string", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "2014-08-09T08:02:04+12:00" ] }, - "contributors_url": { + "email": { "type": "string", - "format": "uri", + "description": "Git email address of the user", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" + "monalisa.octocat@example.com" ] }, - "deployments_url": { + "name": { + "description": "Name of the git user", "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" + "Monalisa Octocat" ] - }, - "downloads_url": { + } + }, + "required": [ + "email", + "name", + "date" + ] + }, + "message": { + "description": "Message describing the purpose of the commit", + "type": "string", + "examples": [ + "Fix #42" + ] + }, + "tree": { + "type": "object", + "properties": { + "sha": { + "description": "SHA for the commit", "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" + "7638417db6d59f3c431d3e1f261cc637155684cd" ] }, - "events_url": { + "url": { "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] + "format": "uri" + } + }, + "required": [ + "sha", + "url" + ] + }, + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sha": { + "description": "SHA for the commit", + "type": "string", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + } }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] + "required": [ + "sha", + "url", + "html_url" + ] + } + }, + "verification": { + "type": "object", + "properties": { + "verified": { + "type": "boolean" }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] + "reason": { + "type": "string" }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + "signature": { + "type": [ + "string", + "null" ] }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + "payload": { + "type": [ + "string", + "null" ] }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" + "verified_at": { + "type": [ + "string", + "null" ] + } + }, + "required": [ + "verified", + "reason", + "signature", + "payload", + "verified_at" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "sha", + "node_id", + "url", + "html_url", + "author", + "committer", + "tree", + "message", + "parents", + "verification" + ] + }, + "examples": { + "default": { + "value": { + "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", + "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd", + "html_url": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd", + "author": { + "date": "2014-11-07T22:01:45Z", + "name": "Monalisa Octocat", + "email": "octocat@github.com" + }, + "committer": { + "date": "2014-11-07T22:01:45Z", + "name": "Monalisa Octocat", + "email": "octocat@github.com" + }, + "message": "added readme, because im a good github citizen", + "tree": { + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb", + "sha": "691272480426f78a0138979dd3ce63b77f706feb" + }, + "parents": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5", + "sha": "1acc419d4d6a9ce985db7be48c6349a0475975b5", + "html_url": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" + } + ], + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null, + "verified_at": 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" + } + } + } + } + } + }, + "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": "git", + "subcategory": "commits" + } + } + }, + "/repos/{owner}/{repo}/git/matching-refs/{ref}": { + "get": { + "summary": "List matching references", + "description": "Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array.\n\nWhen you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`.\n\n> [!NOTE]\n> You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nIf you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`.", + "tags": [ + "git" + ], + "operationId": "git/list-matching-refs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/git/refs#list-matching-references" + }, + "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": "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.", + "in": "path", + "required": true, + "example": "heads/feature-a", + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Git Reference", + "description": "Git references within a repository", + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "object": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "sha": { + "description": "SHA for the reference", + "type": "string", + "minLength": 40, + "maxLength": 40, + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "url": { + "type": "string", + "format": "uri" + } }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] + "required": [ + "type", + "sha", + "url" + ] + } + }, + "required": [ + "ref", + "node_id", + "url", + "object" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "ref": "refs/heads/feature-a", + "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlLWE=", + "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-a", + "object": { + "type": "commit", + "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd" + } + }, + { + "ref": "refs/heads/feature-b", + "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlLWI=", + "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-b", + "object": { + "type": "commit", + "sha": "612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac", + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac" + } + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "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": "git", + "subcategory": "refs" + } + } + }, + "/repos/{owner}/{repo}/git/ref/{ref}": { + "get": { + "summary": "Get a reference", + "description": "Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.\n\n> [!NOTE]\n> You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".", + "tags": [ + "git" + ], + "operationId": "git/get-ref", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/git/refs#get-a-reference" + }, + "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": "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.", + "in": "path", + "required": true, + "example": "heads/feature-a", + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Git Reference", + "description": "Git references within a repository", + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "object": { + "type": "object", + "properties": { + "type": { + "type": "string" }, - "issue_events_url": { + "sha": { + "description": "SHA for the reference", "type": "string", + "minLength": 40, + "maxLength": 40, "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + "7638417db6d59f3c431d3e1f261cc637155684cd" ] }, - "issues_url": { + "url": { "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] + "format": "uri" + } + }, + "required": [ + "type", + "sha", + "url" + ] + } + }, + "required": [ + "ref", + "node_id", + "url", + "object" + ] + }, + "examples": { + "default": { + "value": { + "ref": "refs/heads/featureA", + "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==", + "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA", + "object": { + "type": "commit", + "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd" + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/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" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "git", + "subcategory": "refs" + } + } + }, + "/repos/{owner}/{repo}/git/refs": { + "post": { + "summary": "Create a reference", + "description": "Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.", + "tags": [ + "git" + ], + "operationId": "git/create-ref", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/git/refs#create-a-reference" + }, + "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": { + "ref": { + "type": "string", + "description": "The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected." + }, + "sha": { + "type": "string", + "description": "The SHA1 value for this reference." + } + }, + "required": [ + "ref", + "sha" + ] + }, + "examples": { + "default": { + "value": { + "ref": "refs/heads/featureA", + "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Git Reference", + "description": "Git references within a repository", + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "object": { + "type": "object", + "properties": { + "type": { + "type": "string" }, - "keys_url": { + "sha": { + "description": "SHA for the reference", "type": "string", + "minLength": 40, + "maxLength": 40, "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + "7638417db6d59f3c431d3e1f261cc637155684cd" ] }, - "labels_url": { + "url": { "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] + "format": "uri" + } + }, + "required": [ + "type", + "sha", + "url" + ] + } + }, + "required": [ + "ref", + "node_id", + "url", + "object" + ] + }, + "examples": { + "default": { + "value": { + "ref": "refs/heads/featureA", + "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==", + "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA", + "object": { + "type": "commit", + "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd" + } + } + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA", + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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": "git", + "subcategory": "refs" + } + } + }, + "/repos/{owner}/{repo}/git/refs/{ref}": { + "patch": { + "summary": "Update a reference", + "description": "Updates the provided reference to point to a new SHA. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.", + "tags": [ + "git" + ], + "operationId": "git/update-ref", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/git/refs#update-a-reference" + }, + "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": "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.", + "in": "path", + "required": true, + "example": "heads/feature-a", + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "description": "The SHA1 value to set this reference to" + }, + "force": { + "type": "boolean", + "description": "Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work.", + "default": false + } + }, + "required": [ + "sha" + ] + }, + "examples": { + "default": { + "value": { + "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", + "force": true + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Git Reference", + "description": "Git references within a repository", + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "object": { + "type": "object", + "properties": { + "type": { + "type": "string" }, - "languages_url": { + "sha": { + "description": "SHA for the reference", "type": "string", - "format": "uri", + "minLength": 40, + "maxLength": 40, "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" + "7638417db6d59f3c431d3e1f261cc637155684cd" ] }, - "merges_url": { + "url": { "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] + "format": "uri" + } + }, + "required": [ + "type", + "sha", + "url" + ] + } + }, + "required": [ + "ref", + "node_id", + "url", + "object" + ] + }, + "examples": { + "default": { + "value": { + "ref": "refs/heads/featureA", + "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==", + "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA", + "object": { + "type": "commit", + "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd" + } + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "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": "git", + "subcategory": "refs" + } + }, + "delete": { + "summary": "Delete a reference", + "description": "Deletes the provided reference.", + "tags": [ + "git" + ], + "operationId": "git/delete-ref", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/git/refs#delete-a-reference" + }, + "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": "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.", + "in": "path", + "required": true, + "example": "heads/feature-a", + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "responses": { + "204": { + "description": "Response" + }, + "422": { + "description": "Validation failed, an attempt was made to delete the default branch, or the endpoint has been spammed." + }, + "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": "git", + "subcategory": "refs" + } + } + }, + "/repos/{owner}/{repo}/git/tags": { + "post": { + "summary": "Create a tag object", + "description": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "tags": [ + "git" + ], + "operationId": "git/create-tag", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/git/tags#create-a-tag-object" + }, + "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": { + "tag": { + "type": "string", + "description": "The tag's name. This is typically a version (e.g., \"v0.0.1\")." + }, + "message": { + "type": "string", + "description": "The tag message." + }, + "object": { + "type": "string", + "description": "The SHA of the git object this is tagging." + }, + "type": { + "type": "string", + "description": "The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`.", + "enum": [ + "commit", + "tree", + "blob" + ] + }, + "tagger": { + "type": "object", + "description": "An object with information about the individual creating the tag.", + "properties": { + "name": { + "type": "string", + "description": "The name of the author of the tag" + }, + "email": { + "type": "string", + "description": "The email of the author of the tag" + }, + "date": { + "type": "string", + "format": "date-time", + "description": "When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." + } + }, + "required": [ + "name", + "email" + ] + } + }, + "required": [ + "tag", + "message", + "object", + "type" + ] + }, + "examples": { + "default": { + "value": { + "tag": "v0.0.1", + "message": "initial version", + "object": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c", + "type": "commit", + "tagger": { + "name": "Monalisa Octocat", + "email": "octocat@github.com", + "date": "2011-06-17T14:53:35-07:00" + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Git Tag", + "description": "Metadata for a Git tag", + "type": "object", + "properties": { + "node_id": { + "type": "string", + "examples": [ + "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==" + ] + }, + "tag": { + "description": "Name of the tag", + "type": "string", + "examples": [ + "v0.0.1" + ] + }, + "sha": { + "type": "string", + "examples": [ + "940bd336248efae0f9ee5bc7b2d5c985887b16ac" + ] + }, + "url": { + "description": "URL for the tag", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac" + ] + }, + "message": { + "description": "Message describing the purpose of the tag", + "type": "string", + "examples": [ + "Initial public release" + ] + }, + "tagger": { + "type": "object", + "properties": { + "date": { + "type": "string" }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] + "email": { + "type": "string" }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] + "name": { + "type": "string" + } + }, + "required": [ + "date", + "email", + "name" + ] + }, + "object": { + "type": "object", + "properties": { + "sha": { + "type": "string" }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] + "type": { + "type": "string" }, - "releases_url": { + "url": { "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] + "format": "uri" + } + }, + "required": [ + "sha", + "type", + "url" + ] + }, + "verification": { + "title": "Verification", + "type": "object", + "properties": { + "verified": { + "type": "boolean" }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] + "reason": { + "type": "string" }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" + "payload": { + "type": [ + "string", + "null" ] }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + "signature": { + "type": [ + "string", + "null" ] }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" + "verified_at": { + "type": [ + "string", + "null" ] + } + }, + "required": [ + "verified", + "reason", + "payload", + "signature", + "verified_at" + ] + } + }, + "required": [ + "sha", + "url", + "node_id", + "tagger", + "object", + "tag", + "message" + ] + }, + "examples": { + "default": { + "value": { + "node_id": "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==", + "tag": "v0.0.1", + "sha": "940bd336248efae0f9ee5bc7b2d5c985887b16ac", + "url": "https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac", + "message": "initial version", + "tagger": { + "name": "Monalisa Octocat", + "email": "octocat@github.com", + "date": "2014-11-07T22:01:45Z" + }, + "object": { + "type": "commit", + "sha": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c", + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c" + }, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null, + "verified_at": null + } + } + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac", + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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": "git", + "subcategory": "tags" + } + } + }, + "/repos/{owner}/{repo}/git/tags/{tag_sha}": { + "get": { + "summary": "Get a tag", + "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "tags": [ + "git" + ], + "operationId": "git/get-tag", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/git/tags#get-a-tag" + }, + "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": "tag_sha", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Git Tag", + "description": "Metadata for a Git tag", + "type": "object", + "properties": { + "node_id": { + "type": "string", + "examples": [ + "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==" + ] + }, + "tag": { + "description": "Name of the tag", + "type": "string", + "examples": [ + "v0.0.1" + ] + }, + "sha": { + "type": "string", + "examples": [ + "940bd336248efae0f9ee5bc7b2d5c985887b16ac" + ] + }, + "url": { + "description": "URL for the tag", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac" + ] + }, + "message": { + "description": "Message describing the purpose of the tag", + "type": "string", + "examples": [ + "Initial public release" + ] + }, + "tagger": { + "type": "object", + "properties": { + "date": { + "type": "string" }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] + "email": { + "type": "string" }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] + "name": { + "type": "string" + } + }, + "required": [ + "date", + "email", + "name" + ] + }, + "object": { + "type": "object", + "properties": { + "sha": { + "type": "string" }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] + "type": { + "type": "string" }, - "trees_url": { + "url": { "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] + "format": "uri" + } + }, + "required": [ + "sha", + "type", + "url" + ] + }, + "verification": { + "title": "Verification", + "type": "object", + "properties": { + "verified": { + "type": "boolean" }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] + "reason": { + "type": "string" }, - "mirror_url": { + "payload": { "type": [ "string", "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { + "signature": { "type": [ "string", "null" - ], - "format": "uri", - "examples": [ - "https://github.com" ] }, - "language": { + "verified_at": { "type": [ "string", "null" ] + } + }, + "required": [ + "verified", + "reason", + "payload", + "signature", + "verified_at" + ] + } + }, + "required": [ + "sha", + "url", + "node_id", + "tagger", + "object", + "tag", + "message" + ] + }, + "examples": { + "default": { + "value": { + "node_id": "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==", + "tag": "v0.0.1", + "sha": "940bd336248efae0f9ee5bc7b2d5c985887b16ac", + "url": "https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac", + "message": "initial version", + "tagger": { + "name": "Monalisa Octocat", + "email": "octocat@github.com", + "date": "2014-11-07T22:01:45Z" + }, + "object": { + "type": "commit", + "sha": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c", + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c" + }, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null, + "verified_at": 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" + } + } + } + } + } + }, + "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": "git", + "subcategory": "tags" + } + } + }, + "/repos/{owner}/{repo}/git/trees": { + "post": { + "summary": "Create a tree", + "description": "The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.\n\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"[Create a commit](https://docs.github.com/rest/git/commits#create-a-commit)\" and \"[Update a reference](https://docs.github.com/rest/git/refs#update-a-reference).\"\n\nReturns an error if you try to delete a file that does not exist.", + "tags": [ + "git" + ], + "operationId": "git/create-tree", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/git/trees#create-a-tree" + }, + "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": { + "tree": { + "type": "array", + "description": "Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure.", + "items": { + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file referenced in the tree." }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 + "mode": { + "type": "string", + "description": "The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink.", + "enum": [ + "100644", + "100755", + "040000", + "160000", + "120000" ] }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 + "type": { + "type": "string", + "description": "Either `blob`, `tree`, or `commit`.", + "enum": [ + "blob", + "tree", + "commit" ] }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] + "sha": { + "type": [ + "string", + "null" + ], + "description": "The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error." }, - "default_branch": { - "description": "The default branch of the repository.", + "content": { "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] + "description": "The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error." + } + } + } + }, + "base_tree": { + "type": "string", + "description": "The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit." + } + }, + "required": [ + "tree" + ] + }, + "examples": { + "default": { + "value": { + "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312", + "tree": [ + { + "path": "file.rb", + "mode": "100644", + "type": "blob", + "sha": "44b4fc6d56897b048c772eb4087f854f46256132" + } + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Git Tree", + "description": "The hierarchy between files in a Git repository.", + "type": "object", + "properties": { + "sha": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "truncated": { + "type": "boolean" + }, + "tree": { + "description": "Objects specifying a tree structure", + "type": "array", + "items": { + "type": "object", + "required": [ + "path", + "mode", + "type", + "sha" + ], + "properties": { + "path": { + "type": "string", + "examples": [ + "test/file.rb" + ] + }, + "mode": { + "type": "string", + "examples": [ + "040000" + ] + }, + "type": { + "type": "string", + "examples": [ + "tree" + ] + }, + "sha": { + "type": "string", + "examples": [ + "23f6827669e43831def8a7ad935069c8bd418261" + ] + }, + "size": { + "type": "integer", + "examples": [ + 12 + ] + }, + "url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/owner-482f3203ecf01f67e9deb18e/BBB_Private_Repo/git/blobs/23f6827669e43831def8a7ad935069c8bd418261" + ] + } + } + }, + "examples": [ + { + "path": "file.rb", + "mode": "100644", + "type": "blob", + "size": 30, + "sha": "44b4fc6d56897b048c772eb4087f854f46256132", + "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132" + } + ] + } + }, + "required": [ + "sha", + "tree", + "truncated" + ] + }, + "examples": { + "default": { + "value": { + "sha": "cd8274d15fa3ae2ab983129fb037999f264ba9a7", + "url": "https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7", + "tree": [ + { + "path": "file.rb", + "mode": "100644", + "type": "blob", + "size": 132, + "sha": "7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b", + "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b" + } + ], + "truncated": true + } + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7", + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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" + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "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": "git", + "subcategory": "trees" + } + } + }, + "/repos/{owner}/{repo}/git/trees/{tree_sha}": { + "get": { + "summary": "Get a tree", + "description": "Returns a single tree using the SHA1 value or ref name for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.\n\n> [!NOTE]\n> The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.", + "tags": [ + "git" + ], + "operationId": "git/get-tree", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/git/trees#get-a-tree" + }, + "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": "tree_sha", + "description": "The SHA1 value or ref (branch or tag) name of the tree.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + { + "name": "recursive", + "description": "Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` to any of the following will enable returning objects or subtrees: `0`, `1`, `\"true\"`, and `\"false\"`. Omit this parameter to prevent recursively returning objects or subtrees.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Git Tree", + "description": "The hierarchy between files in a Git repository.", + "type": "object", + "properties": { + "sha": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "truncated": { + "type": "boolean" + }, + "tree": { + "description": "Objects specifying a tree structure", + "type": "array", + "items": { + "type": "object", + "required": [ + "path", + "mode", + "type", + "sha" + ], + "properties": { + "path": { + "type": "string", + "examples": [ + "test/file.rb" + ] + }, + "mode": { + "type": "string", + "examples": [ + "040000" + ] + }, + "type": { + "type": "string", + "examples": [ + "tree" + ] + }, + "sha": { + "type": "string", + "examples": [ + "23f6827669e43831def8a7ad935069c8bd418261" + ] + }, + "size": { + "type": "integer", + "examples": [ + 12 + ] + }, + "url": { + "type": "string", + "examples": [ + "https://api.github.com/repos/owner-482f3203ecf01f67e9deb18e/BBB_Private_Repo/git/blobs/23f6827669e43831def8a7ad935069c8bd418261" + ] + } + } + }, + "examples": [ + { + "path": "file.rb", + "mode": "100644", + "type": "blob", + "size": 30, + "sha": "44b4fc6d56897b048c772eb4087f854f46256132", + "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132" + } + ] + } + }, + "required": [ + "sha", + "tree", + "truncated" + ] + }, + "examples": { + "default-response": { + "summary": "Default response", + "value": { + "sha": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312", + "url": "https://api.github.com/repos/octocat/Hello-World/trees/9fb037999f264ba9a7fc6274d15fa3ae2ab98312", + "tree": [ + { + "path": "file.rb", + "mode": "100644", + "type": "blob", + "size": 30, + "sha": "44b4fc6d56897b048c772eb4087f854f46256132", + "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132" }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] + { + "path": "subdir", + "mode": "040000", + "type": "tree", + "sha": "f484d249c660418515fb01c2b9662073663c242e", + "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/f484d249c660418515fb01c2b9662073663c242e" }, - "topics": { - "type": "array", - "items": { + { + "path": "exec_file", + "mode": "100755", + "type": "blob", + "size": 75, + "sha": "45b983be36b73c0788dc9cbcb76cbb80fc7bb057", + "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/45b983be36b73c0788dc9cbcb76cbb80fc7bb057" + } + ], + "truncated": false + } + }, + "response-recursively-retrieving-a-tree": { + "summary": "Response recursively retrieving a tree", + "value": { + "sha": "fc6274d15fa3ae2ab983129fb037999f264ba9a7", + "url": "https://api.github.com/repos/octocat/Hello-World/trees/fc6274d15fa3ae2ab983129fb037999f264ba9a7", + "tree": [ + { + "path": "subdir/file.txt", + "mode": "100644", + "type": "blob", + "size": 132, + "sha": "7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b", + "url": "https://api.github.com/repos/octocat/Hello-World/git/7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b" + } + ], + "truncated": false + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/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" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "git", + "subcategory": "trees" + } + } + }, + "/repos/{owner}/{repo}/hooks": { + "get": { + "summary": "List repository webhooks", + "description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.", + "tags": [ + "repos" + ], + "operationId": "repos/list-webhooks", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/webhooks#list-repository-webhooks" + }, + "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": "Webhook", + "description": "Webhooks for repositories.", + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "id": { + "description": "Unique identifier of the webhook.", + "type": "integer", + "examples": [ + 42 + ] + }, + "name": { + "description": "The name of a valid service, use 'web' for a webhook.", + "type": "string", + "examples": [ + "web" + ] + }, + "active": { + "description": "Determines whether the hook is actually triggered on pushes.", + "type": "boolean", + "examples": [ + true + ] + }, + "events": { + "description": "Determines what events the hook is triggered for. Default: ['push'].", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "push", + "pull_request" + ] + }, + "config": { + "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.", + "format": "uri", + "examples": [ + "https://example.com/webhook" + ] + }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"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).", + "examples": [ + "\"********\"" + ] + }, + "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.**", + "examples": [ + "\"0\"" + ] + }, + { + "type": "number" + } + ] + } + } + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-09-06T20:39:23Z" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-09-06T17:26:27Z" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks/1" + ] + }, + "test_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks/1/test" + ] + }, + "ping_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks/1/pings" + ] + }, + "deliveries_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries" + ] + }, + "last_response": { + "title": "Hook Response", + "type": "object", + "properties": { + "code": { + "type": [ + "integer", + "null" + ] + }, + "status": { + "type": [ + "string", + "null" + ] + }, + "message": { + "type": [ + "string", + "null" + ] } }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] + "required": [ + "code", + "status", + "message" + ] + } + }, + "required": [ + "id", + "url", + "type", + "name", + "active", + "events", + "config", + "ping_url", + "created_at", + "updated_at", + "last_response", + "test_url" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "type": "Repository", + "id": 12345678, + "name": "web", + "active": true, + "events": [ + "push", + "pull_request" + ], + "config": { + "content_type": "json", + "insecure_ssl": "0", + "url": "https://example.com/webhook" }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", + "updated_at": "2019-06-03T00:57:16Z", + "created_at": "2019-06-03T00:57:16Z", + "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", + "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test", + "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings", + "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", + "last_response": { + "code": null, + "status": "unused", + "message": null + } + } + ] + } + } + } + }, + "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": "repos", + "subcategory": "webhooks" + } + }, + "post": { + "summary": "Create a repository webhook", + "description": "Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can\nshare the same `config` as long as those webhooks do not have any `events` that overlap.", + "tags": [ + "repos" + ], + "operationId": "repos/create-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook" + }, + "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": false, + "content": { + "application/json": { + "schema": { + "type": [ + "object", + "null" + ], + "properties": { + "name": { + "type": "string", + "description": "Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `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.", + "format": "uri", + "examples": [ + "https://example.com/webhook" + ] + }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"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).", + "examples": [ + "\"********\"" + ] + }, + "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.**", + "examples": [ + "\"0\"" + ] + }, + { + "type": "number" + } + ] + } + } + }, + "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 + } + }, + "additionalProperties": false + }, + "examples": { + "default": { + "value": { + "name": "web", + "active": true, + "events": [ + "push", + "pull_request" + ], + "config": { + "url": "https://example.com/webhook", + "content_type": "json", + "insecure_ssl": "0" + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Webhook", + "description": "Webhooks for repositories.", + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "id": { + "description": "Unique identifier of the webhook.", + "type": "integer", + "examples": [ + 42 + ] + }, + "name": { + "description": "The name of a valid service, use 'web' for a webhook.", + "type": "string", + "examples": [ + "web" + ] + }, + "active": { + "description": "Determines whether the hook is actually triggered on pushes.", + "type": "boolean", + "examples": [ + true + ] + }, + "events": { + "description": "Determines what events the hook is triggered for. Default: ['push'].", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "push", + "pull_request" + ] + }, + "config": { + "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.", + "format": "uri", "examples": [ - true + "https://example.com/webhook" ] }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "examples": [ - true + "\"json\"" ] }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, + "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).", "examples": [ - true + "\"********\"" ] }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true + "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.**", + "examples": [ + "\"0\"" + ] + }, + { + "type": "number" + } ] - }, - "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": { + } + } + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-09-06T20:39:23Z" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-09-06T17:26:27Z" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks/1" + ] + }, + "test_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks/1/test" + ] + }, + "ping_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks/1/pings" + ] + }, + "deliveries_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries" + ] + }, + "last_response": { + "title": "Hook Response", + "type": "object", + "properties": { + "code": { "type": [ - "string", + "integer", "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" ] }, - "created_at": { + "status": { "type": [ "string", "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" ] }, - "updated_at": { + "message": { "type": [ "string", "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } } }, "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" + "code", + "status", + "message" ] + } + }, + "required": [ + "id", + "url", + "type", + "name", + "active", + "events", + "config", + "ping_url", + "created_at", + "updated_at", + "last_response", + "test_url" + ] + }, + "examples": { + "default": { + "value": { + "type": "Repository", + "id": 12345678, + "name": "web", + "active": true, + "events": [ + "push", + "pull_request" + ], + "config": { + "content_type": "json", + "insecure_ssl": "0", + "url": "https://example.com/webhook" + }, + "updated_at": "2019-06-03T00:57:16Z", + "created_at": "2019-06-03T00:57:16Z", + "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", + "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test", + "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings", + "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", + "last_response": { + "code": null, + "status": "unused", + "message": null + } + } + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", + "schema": { + "type": "string" + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "forks": { - "type": "integer" + "documentation_url": { + "type": "string" }, - "master_branch": { + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "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": "repos", + "subcategory": "webhooks" + } + } + }, + "/repos/{owner}/{repo}/hooks/{hook_id}": { + "get": { + "summary": "Get a repository webhook", + "description": "Returns a webhook configured in a repository. To get only the webhook `config` properties, see \"[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository).\"", + "tags": [ + "repos" + ], + "operationId": "repos/get-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook" + }, + "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": "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", + "description": "Webhooks for repositories.", + "type": "object", + "properties": { + "type": { "type": "string" }, - "open_issues": { - "type": "integer" + "id": { + "description": "Unique identifier of the webhook.", + "type": "integer", + "examples": [ + 42 + ] }, - "watchers": { - "type": "integer" + "name": { + "description": "The name of a valid service, use 'web' for a webhook.", + "type": "string", + "examples": [ + "web" + ] }, - "anonymous_access_enabled": { - "description": "Whether anonymous git access is allowed.", - "default": true, - "type": "boolean" + "active": { + "description": "Determines whether the hook is actually triggered on pushes.", + "type": "boolean", + "examples": [ + true + ] }, - "code_of_conduct": { - "title": "Code Of Conduct Simple", - "description": "Code of Conduct Simple", + "events": { + "description": "Determines what events the hook is triggered for. Default: ['push'].", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "push", + "pull_request" + ] + }, + "config": { + "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.", "format": "uri", "examples": [ - "https://api.github.com/repos/github/docs/community/code_of_conduct" + "https://example.com/webhook" ] }, - "key": { + "content_type": { "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "examples": [ - "citizen_code_of_conduct" + "\"json\"" ] }, - "name": { + "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).", "examples": [ - "Citizen Code of Conduct" + "\"********\"" ] }, - "html_url": { + "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.**", + "examples": [ + "\"0\"" + ] + }, + { + "type": "number" + } + ] + } + } + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-09-06T20:39:23Z" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-09-06T17:26:27Z" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks/1" + ] + }, + "test_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks/1/test" + ] + }, + "ping_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks/1/pings" + ] + }, + "deliveries_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries" + ] + }, + "last_response": { + "title": "Hook Response", + "type": "object", + "properties": { + "code": { + "type": [ + "integer", + "null" + ] + }, + "status": { + "type": [ + "string", + "null" + ] + }, + "message": { "type": [ "string", "null" - ], - "format": "uri", - "examples": [ - "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md" ] } }, "required": [ - "url", - "key", - "name", - "html_url" + "code", + "status", + "message" ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" + } + }, + "required": [ + "id", + "url", + "type", + "name", + "active", + "events", + "config", + "ping_url", + "created_at", + "updated_at", + "last_response", + "test_url" + ] + }, + "examples": { + "default": { + "value": { + "type": "Repository", + "id": 12345678, + "name": "web", + "active": true, + "events": [ + "push", + "pull_request" ], - "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" - ] - } + "config": { + "content_type": "json", + "insecure_ssl": "0", + "url": "https://example.com/webhook" + }, + "updated_at": "2019-06-03T00:57:16Z", + "created_at": "2019-06-03T00:57:16Z", + "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", + "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test", + "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings", + "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", + "last_response": { + "code": null, + "status": "unused", + "message": 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" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "webhooks" + } + }, + "patch": { + "summary": "Update a repository webhook", + "description": "Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use \"[Update a webhook configuration for a repository](/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository).\"", + "tags": [ + "repos" + ], + "operationId": "repos/update-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook" + }, + "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": "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, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "config": { + "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.", + "format": "uri", + "examples": [ + "https://example.com/webhook" + ] + }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"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).", + "examples": [ + "\"********\"" + ] + }, + "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.**", + "examples": [ + "\"0\"" + ] + }, + { + "type": "number" } + ] + } + } + }, + "events": { + "type": "array", + "description": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events.", + "default": [ + "push" + ], + "items": { + "type": "string" + } + }, + "add_events": { + "type": "array", + "description": "Determines a list of events to be added to the list of events that the Hook triggers for.", + "items": { + "type": "string" + } + }, + "remove_events": { + "type": "array", + "description": "Determines a list of events to be removed from the list of events that the Hook triggers for.", + "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 + } + } + }, + "examples": { + "default": { + "value": { + "active": true, + "add_events": [ + "pull_request" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Webhook", + "description": "Webhooks for repositories.", + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "id": { + "description": "Unique identifier of the webhook.", + "type": "integer", + "examples": [ + 42 + ] + }, + "name": { + "description": "The name of a valid service, use 'web' for a webhook.", + "type": "string", + "examples": [ + "web" + ] + }, + "active": { + "description": "Determines whether the hook is actually triggered on pushes.", + "type": "boolean", + "examples": [ + true + ] + }, + "events": { + "description": "Determines what events the hook is triggered for. Default: ['push'].", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "push", + "pull_request" + ] + }, + "config": { + "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.", + "format": "uri", + "examples": [ + "https://example.com/webhook" + ] }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"json\"" + ] }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } + "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).", + "examples": [ + "\"********\"" + ] }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { + "insecure_ssl": { + "oneOf": [ + { "type": "string", - "enum": [ - "enabled", - "disabled" + "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.**", + "examples": [ + "\"0\"" ] + }, + { + "type": "number" } - } + ] } } }, - "custom_properties": { + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-09-06T20:39:23Z" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-09-06T17:26:27Z" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks/1" + ] + }, + "test_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks/1/test" + ] + }, + "ping_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks/1/pings" + ] + }, + "deliveries_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries" + ] + }, + "last_response": { + "title": "Hook Response", "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": { + "code": { + "type": [ + "integer", + "null" + ] + }, + "status": { + "type": [ + "string", + "null" + ] + }, + "message": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "code", + "status", + "message" + ] } }, "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_issues", - "has_projects", - "has_wiki", - "has_pages", - "has_discussions", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", + "type", + "name", + "active", + "events", + "config", + "ping_url", "created_at", "updated_at", - "network_count", - "subscribers_count" + "last_response", + "test_url" ] }, "examples": { "default": { "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}", - "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", - "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" - }, - "language": null, - "forks_count": 9, - "forks": 9, - "stargazers_count": 80, - "watchers_count": 80, - "watchers": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "open_issues": 0, - "is_template": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" + "type": "Repository", + "id": 12345678, + "name": "web", + "active": true, + "events": [ + "push", + "pull_request" ], - "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": { - "pull": true, - "push": false, - "admin": false + "config": { + "content_type": "json", + "insecure_ssl": "0", + "url": "https://example.com/webhook" }, - "allow_rebase_merge": true, - "template_repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World-Template", - "full_name": "octocat/Hello-World-Template", - "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 + "updated_at": "2019-06-03T00:57:16Z", + "created_at": "2019-06-03T00:57:16Z", + "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", + "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test", + "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings", + "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", + "last_response": { + "code": null, + "status": "unused", + "message": null + } + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/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": "repos", + "subcategory": "webhooks" + } + }, + "delete": { + "summary": "Delete a repository webhook", + "description": "Delete a webhook for an organization.\n\nThe authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook.", + "tags": [ + "repos" + ], + "operationId": "repos/delete-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook" + }, + "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": "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", + "content": { + "application/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": "repos", + "subcategory": "webhooks" + } + } + }, + "/repos/{owner}/{repo}/hooks/{hook_id}/config": { + "get": { + "summary": "Get a webhook configuration for a repository", + "description": "Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use \"[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/get-webhook-config-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-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": "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.", + "format": "uri", + "examples": [ + "https://example.com/webhook" + ] + }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"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).", + "examples": [ + "\"********\"" + ] + }, + "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.**", + "examples": [ + "\"0\"" + ] }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World-Template", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World-Template", - "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World-Template.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World-Template.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World-Template.git", - "mirror_url": "git:git.example.com/octocat/Hello-World-Template", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World-Template", - "homepage": "https://github.com", - "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" + { + "type": "number" + } + ] + } + } + }, + "examples": { + "default": { + "value": { + "content_type": "json", + "insecure_ssl": "0", + "secret": "********", + "url": "https://example.com/webhook" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "webhooks" + } + }, + "patch": { + "summary": "Update a webhook configuration for a repository", + "description": "Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use \"[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/update-webhook-config-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-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": "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", + "additionalProperties": false, + "properties": { + "url": { + "type": "string", + "description": "The URL to which the payloads will be delivered.", + "format": "uri", + "examples": [ + "https://example.com/webhook" + ] + }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"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).", + "examples": [ + "\"********\"" + ] + }, + "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.**", + "examples": [ + "\"0\"" + ] + }, + { + "type": "number" + } + ] + } + } + }, + "examples": { + "default": { + "summary": "Example of updating content type and URL", + "value": { + "content_type": "json", + "url": "https://example.com/webhook" + } + } + } + } + } + }, + "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.", + "format": "uri", + "examples": [ + "https://example.com/webhook" + ] + }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"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).", + "examples": [ + "\"********\"" + ] + }, + "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.**", + "examples": [ + "\"0\"" + ] }, - "topics": [ - "octocat", - "atom", - "electron", - "api" + { + "type": "number" + } + ] + } + } + }, + "examples": { + "default": { + "value": { + "content_type": "json", + "insecure_ssl": "0", + "secret": "********", + "url": "https://example.com/webhook" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "webhooks" + } + } + }, + "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries": { + "get": { + "summary": "List deliveries for a repository webhook", + "description": "Returns a list of webhook deliveries for a webhook configured in a repository.", + "tags": [ + "repos" + ], + "operationId": "repos/list-webhook-deliveries", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook" + }, + "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": "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" + } + } + ], + "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", + "examples": [ + 42 + ] + }, + "guid": { + "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", + "type": "string", + "examples": [ + "58474f00-b361-11eb-836d-0e4f3503ccbe" + ] + }, + "delivered_at": { + "description": "Time when the webhook delivery occurred.", + "type": "string", + "format": "date-time", + "examples": [ + "2021-05-12T20:33:44Z" + ] + }, + "redelivery": { + "description": "Whether the webhook delivery is a redelivery.", + "type": "boolean", + "examples": [ + false + ] + }, + "duration": { + "description": "Time spent delivering.", + "type": "number", + "examples": [ + 0.03 + ] + }, + "status": { + "description": "Describes the response returned after attempting the delivery.", + "type": "string", + "examples": [ + "failed to connect" + ] + }, + "status_code": { + "description": "Status code received when delivery was made.", + "type": "integer", + "examples": [ + 502 + ] + }, + "event": { + "description": "The event that triggered the delivery.", + "type": "string", + "examples": [ + "issues" + ] + }, + "action": { + "description": "The type of activity for the event that triggered the delivery.", + "type": [ + "string", + "null" ], - "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, - "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 + "examples": [ + "opened" + ] }, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "allow_forking": true, - "web_commit_signoff_required": false, - "subscribers_count": 42, - "network_count": 0, - "organization": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "Organization", - "site_admin": false + "installation_id": { + "description": "The id of the GitHub App installation associated with this event.", + "type": [ + "integer", + "null" + ], + "format": "int64", + "examples": [ + 123 + ] }, - "parent": { - "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" + "repository_id": { + "description": "The id of the repository associated with this event.", + "type": [ + "integer", + "null" ], - "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, - "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://api.github.com/licenses/mit" + "format": "int64", + "examples": [ + 123 + ] + }, + "throttled_at": { + "description": "Time when the webhook delivery was throttled.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2021-05-12T20:33:44Z" + ] + } + }, + "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "webhooks" + } + } + }, + "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}": { + "get": { + "summary": "Get a delivery for a repository webhook", + "description": "Returns a delivery for a webhook configured in a repository.", + "tags": [ + "repos" + ], + "operationId": "repos/get-webhook-delivery", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook" + }, + "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": "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": "Webhook delivery", + "description": "Delivery made by a webhook.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the delivery.", + "type": "integer", + "examples": [ + 42 + ] + }, + "guid": { + "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", + "type": "string", + "examples": [ + "58474f00-b361-11eb-836d-0e4f3503ccbe" + ] + }, + "delivered_at": { + "description": "Time when the delivery was delivered.", + "type": "string", + "format": "date-time", + "examples": [ + "2021-05-12T20:33:44Z" + ] + }, + "redelivery": { + "description": "Whether the delivery is a redelivery.", + "type": "boolean", + "examples": [ + false + ] + }, + "duration": { + "description": "Time spent delivering.", + "type": "number", + "examples": [ + 0.03 + ] + }, + "status": { + "description": "Description of the status of the attempted delivery", + "type": "string", + "examples": [ + "failed to connect" + ] + }, + "status_code": { + "description": "Status code received when delivery was made.", + "type": "integer", + "examples": [ + 502 + ] + }, + "event": { + "description": "The event that triggered the delivery.", + "type": "string", + "examples": [ + "issues" + ] + }, + "action": { + "description": "The type of activity for the event that triggered the delivery.", + "type": [ + "string", + "null" + ], + "examples": [ + "opened" + ] + }, + "installation_id": { + "description": "The id of the GitHub App installation associated with this event.", + "type": [ + "integer", + "null" + ], + "examples": [ + 123 + ] + }, + "repository_id": { + "description": "The id of the repository associated with this event.", + "type": [ + "integer", + "null" + ], + "examples": [ + 123 + ] + }, + "throttled_at": { + "description": "Time when the webhook delivery was throttled.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2021-05-12T20:33:44Z" + ] + }, + "url": { + "description": "The URL target of the delivery.", + "type": "string", + "examples": [ + "https://www.example.com" + ] + }, + "request": { + "type": "object", + "properties": { + "headers": { + "description": "The request headers sent with the webhook delivery.", + "type": [ + "object", + "null" + ], + "additionalProperties": true }, - "forks": 1, - "open_issues": 1, - "watchers": 1 + "payload": { + "description": "The webhook payload.", + "type": [ + "object", + "null" + ], + "additionalProperties": true + } }, - "source": { - "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 + "required": [ + "headers", + "payload" + ] + }, + "response": { + "type": "object", + "properties": { + "headers": { + "description": "The response headers received when the delivery was made.", + "type": [ + "object", + "null" + ], + "additionalProperties": true }, - "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 + "payload": { + "description": "The response payload received.", + "type": [ + "string", + "null" + ], + "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" }, - "allow_rebase_merge": true, - "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://api.github.com/licenses/mit" + "payload": { + "action": "opened", + "issue": { + "body": "foo" + }, + "repository": { + "id": 123 + } + } + }, + "response": { + "headers": { + "Content-Type": "text/html;charset=utf-8" }, - "forks": 1, - "open_issues": 1, - "watchers": 1 + "payload": "ok" } } } @@ -329062,79 +340249,27 @@ } } } - }, - "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": "repos", - "subcategory": "forks" + "subcategory": "webhooks" } } }, - "/repos/{owner}/{repo}/git/blobs": { + "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { "post": { - "summary": "Create a blob", - "description": "", + "summary": "Redeliver a delivery for a repository webhook", + "description": "Redeliver a webhook delivery for a webhook configured in a repository.", "tags": [ - "git" + "repos" ], - "operationId": "git/create-blob", + "operationId": "repos/redeliver-webhook-delivery", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/git/blobs#create-a-blob" + "url": "https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook" }, "parameters": [ { @@ -329154,83 +340289,43 @@ "schema": { "type": "string" } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "content": { - "type": "string", - "description": "The new blob's content." - }, - "encoding": { - "type": "string", - "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", - "default": "utf-8" - } - }, - "required": [ - "content" - ] - }, - "examples": { - "default": { - "value": { - "content": "Content of the blob", - "encoding": "utf-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" + } + }, + { + "name": "delivery_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" } } - }, + ], "responses": { - "201": { - "description": "Response", + "202": { + "description": "Accepted", "content": { "application/json": { "schema": { - "title": "Short Blob", - "description": "Short Blob", - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "sha": { - "type": "string" - } - }, - "required": [ - "url", - "sha" - ] + "type": "object" }, "examples": { "default": { - "value": { - "url": "https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15", - "sha": "3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15" - } + "value": null } } } - }, - "headers": { - "Location": { - "example": "https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15", - "schema": { - "type": "string" - } - } } }, - "404": { - "description": "Resource not found", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -329252,43 +340347,63 @@ } } } - } - } - }, - "409": { - "description": "Conflict", - "content": { - "application/json": { + }, + "application/scim+json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Scim Error", + "description": "Scim Error", "type": "object", "properties": { "message": { - "type": "string" + "type": [ + "string", + "null" + ] }, "documentation_url": { - "type": "string" + "type": [ + "string", + "null" + ] }, - "url": { - "type": "string" + "detail": { + "type": [ + "string", + "null" + ] }, "status": { - "type": "string" + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } } } } } } }, - "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" @@ -329296,132 +340411,58 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "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" + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } + { + "type": [ + "integer", + "null" ] - } - } - } - } - } - }, - { - "description": "Repository rule violation was detected", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "status": { - "type": "string" - }, - "metadata": { - "type": "object", - "properties": { - "secret_scanning": { - "type": "object", - "properties": { - "bypass_placeholders": { - "type": "array", - "items": { - "type": "object", - "properties": { - "placeholder_id": { - "description": "The ID of the push protection bypass placeholder. This value is returned on any push protected routes.", - "type": "string" - }, - "token_type": { - "type": "string" - } - } - } + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" } } - } + ] } } } } - ] + } } } } @@ -329430,22 +340471,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "git", - "subcategory": "blobs" + "category": "repos", + "subcategory": "webhooks" } } }, - "/repos/{owner}/{repo}/git/blobs/{file_sha}": { - "get": { - "summary": "Get a blob", - "description": "The `content` in the response will always be Base64 encoded.\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 blob data.\n- **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified.\n\n**Note** This endpoint supports blobs up to 100 megabytes in size.", + "/repos/{owner}/{repo}/hooks/{hook_id}/pings": { + "post": { + "summary": "Ping a repository webhook", + "description": "This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook.", "tags": [ - "git" + "repos" ], - "operationId": "git/get-blob", + "operationId": "repos/ping-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/git/blobs#get-a-blob" + "url": "https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook" }, "parameters": [ { @@ -329467,73 +340508,98 @@ } }, { - "name": "file_sha", + "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": "string" + "type": "integer" } } ], "responses": { - "200": { - "description": "Response", + "204": { + "description": "Response" + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { - "title": "Blob", - "description": "Blob", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "content": { + "message": { "type": "string" }, - "encoding": { + "documentation_url": { "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "sha": { - "type": "string" - }, - "size": { - "type": [ - "integer", - "null" - ] - }, - "node_id": { "type": "string" }, - "highlighted_content": { + "status": { "type": "string" } - }, - "required": [ - "sha", - "url", - "node_id", - "size", - "content", - "encoding" - ] - }, - "examples": { - "default": { - "value": { - "content": "Q29udGVudCBvZiB0aGUgYmxvYg==", - "encoding": "base64", - "url": "https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15", - "sha": "3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15", - "size": 19, - "node_id": "Q29udGVudCBvZiB0aGUgYmxvYg==" - } } } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "webhooks" + } + } + }, + "/repos/{owner}/{repo}/hooks/{hook_id}/tests": { + "post": { + "summary": "Test the push repository webhook", + "description": "This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated.\n\n> [!NOTE]\n> Previously `/repos/:owner/:repo/hooks/:hook_id/test`", + "tags": [ + "repos" + ], + "operationId": "repos/test-push-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook" + }, + "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": "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", @@ -329560,84 +340626,223 @@ } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "webhooks" + } + } + }, + "/repos/{owner}/{repo}/import": { + "get": { + "summary": "Get an import status", + "description": "View the progress of an import.\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).\n\n**Import status**\n\nThis section includes details about the possible values of the `status` field of the Import Progress response.\n\nAn import that does not have errors will progress through these steps:\n\n* `detecting` - the \"detection\" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL.\n* `importing` - the \"raw\" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import).\n* `mapping` - the \"rewrite\" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.\n* `pushing` - the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is \"Writing objects\".\n* `complete` - the import is complete, and the repository is ready on GitHub.\n\nIf there are problems, you will see one of these in the `status` field:\n\n* `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.\n* `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information.\n* `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.\n* `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/rest/migrations/source-imports#start-an-import) with the correct URL.\n* `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.\n\n**The project_choices field**\n\nWhen multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.\n\n**Git LFS related fields**\n\nThis section includes details about Git LFS related fields that may be present in the Import Progress response.\n\n* `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken.\n* `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step.\n* `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository.\n* `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a \"Get Large Files\" request.", + "tags": [ + "migrations" + ], + "operationId": "migrations/get-import-status", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/migrations/source-imports#get-an-import-status" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + { + "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": { - "title": "Validation Error", - "description": "Validation Error", + "title": "Import", + "description": "A repository import from an external source.", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { - "message": { + "vcs": { + "type": [ + "string", + "null" + ] + }, + "use_lfs": { + "type": "boolean" + }, + "vcs_url": { + "description": "The URL of the originating repository.", "type": "string" }, - "documentation_url": { + "svc_root": { "type": "string" }, - "errors": { + "tfvc_project": { + "type": "string" + }, + "status": { + "type": "string", + "enum": [ + "auth", + "error", + "none", + "detecting", + "choose", + "auth_failed", + "importing", + "mapping", + "waiting_to_push", + "pushing", + "complete", + "setup", + "unknown", + "detection_found_multiple", + "detection_found_nothing", + "detection_needs_auth" + ] + }, + "status_text": { + "type": [ + "string", + "null" + ] + }, + "failed_step": { + "type": [ + "string", + "null" + ] + }, + "error_message": { + "type": [ + "string", + "null" + ] + }, + "import_percent": { + "type": [ + "integer", + "null" + ] + }, + "commit_count": { + "type": [ + "integer", + "null" + ] + }, + "push_percent": { + "type": [ + "integer", + "null" + ] + }, + "has_large_files": { + "type": "boolean" + }, + "large_files_size": { + "type": "integer" + }, + "large_files_count": { + "type": "integer" + }, + "project_choices": { "type": "array", "items": { "type": "object", - "required": [ - "code" - ], "properties": { - "resource": { - "type": "string" - }, - "field": { + "vcs": { "type": "string" }, - "message": { + "tfvc_project": { "type": "string" }, - "code": { + "human_name": { "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] } } } + }, + "message": { + "type": "string" + }, + "authors_count": { + "type": [ + "integer", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "authors_url": { + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "svn_root": { + "type": "string" + } + }, + "required": [ + "vcs", + "vcs_url", + "status", + "url", + "repository_url", + "html_url", + "authors_url" + ] + }, + "examples": { + "default": { + "value": { + "vcs": "subversion", + "use_lfs": true, + "vcs_url": "http://svn.mycompany.com/svn/myproject", + "status": "complete", + "status_text": "Done", + "has_large_files": true, + "large_files_size": 132331036, + "large_files_count": 1, + "authors_count": 4, + "url": "https://api.github.com/repos/octocat/socm/import", + "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" } } } } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -329662,8 +340867,8 @@ } } }, - "409": { - "description": "Conflict", + "503": { + "description": "Unavailable due to service under maintenance.", "content": { "application/json": { "schema": { @@ -329692,22 +340897,23 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "git", - "subcategory": "blobs" - } - } - }, - "/repos/{owner}/{repo}/git/commits": { - "post": { - "summary": "Create a commit", - "description": "Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "category": "migrations", + "subcategory": "source-imports", + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12" + }, + "deprecated": true + }, + "put": { + "summary": "Start an import", + "description": "Start a source import to a GitHub repository using GitHub Importer.\nImporting into a GitHub repository with GitHub Actions enabled is not supported and will\nreturn a status `422 Unprocessable Entity` response.\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", "tags": [ - "git" + "migrations" ], - "operationId": "git/create-commit", + "operationId": "migrations/start-import", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/git/commits#create-a-commit" + "url": "https://docs.github.com/rest/migrations/source-imports#start-an-import" }, "parameters": [ { @@ -329736,87 +340942,44 @@ "schema": { "type": "object", "properties": { - "message": { + "vcs_url": { "type": "string", - "description": "The commit message" + "description": "The URL of the originating repository." }, - "tree": { + "vcs": { "type": "string", - "description": "The SHA of the tree object this commit points to" - }, - "parents": { - "type": "array", - "description": "The full SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.", - "items": { - "type": "string" - } - }, - "author": { - "type": "object", - "description": "Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details.", - "properties": { - "name": { - "type": "string", - "description": "The name of the author (or committer) of the commit" - }, - "email": { - "type": "string", - "description": "The email of the author (or committer) of the commit" - }, - "date": { - "type": "string", - "format": "date-time", - "description": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." - } - }, - "required": [ - "name", - "email" + "description": "The originating VCS type. Without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response.", + "enum": [ + "subversion", + "git", + "mercurial", + "tfvc" ] }, - "committer": { - "type": "object", - "description": "Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details.", - "properties": { - "name": { - "type": "string", - "description": "The name of the author (or committer) of the commit" - }, - "email": { - "type": "string", - "description": "The email of the author (or committer) of the commit" - }, - "date": { - "type": "string", - "format": "date-time", - "description": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." - } - } + "vcs_username": { + "type": "string", + "description": "If authentication is required, the username to provide to `vcs_url`." }, - "signature": { + "vcs_password": { "type": "string", - "description": "The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits." + "description": "If authentication is required, the password to provide to `vcs_url`." + }, + "tfvc_project": { + "type": "string", + "description": "For a tfvc import, the name of the project that is being imported." } }, "required": [ - "message", - "tree" + "vcs_url" ] }, "examples": { "default": { "value": { - "message": "my commit message", - "author": { - "name": "Mona Octocat", - "email": "octocat@github.com", - "date": "2008-07-09T16:13:30+12:00" - }, - "parents": [ - "7d1b31e74ee336d15cbd21741bc88a537ed063a0" - ], - "tree": "827efc6d56897b048c772eb4087f854f46256132", - "signature": "-----BEGIN PGP SIGNATURE-----\n\niQIzBAABAQAdFiEESn/54jMNIrGSE6Tp6cQjvhfv7nAFAlnT71cACgkQ6cQjvhfv\n7nCWwA//XVqBKWO0zF+bZl6pggvky3Oc2j1pNFuRWZ29LXpNuD5WUGXGG209B0hI\nDkmcGk19ZKUTnEUJV2Xd0R7AW01S/YSub7OYcgBkI7qUE13FVHN5ln1KvH2all2n\n2+JCV1HcJLEoTjqIFZSSu/sMdhkLQ9/NsmMAzpf/iIM0nQOyU4YRex9eD1bYj6nA\nOQPIDdAuaTQj1gFPHYLzM4zJnCqGdRlg0sOM/zC5apBNzIwlgREatOYQSCfCKV7k\nnrU34X8b9BzQaUx48Qa+Dmfn5KQ8dl27RNeWAqlkuWyv3pUauH9UeYW+KyuJeMkU\n+NyHgAsWFaCFl23kCHThbLStMZOYEnGagrd0hnm1TPS4GJkV4wfYMwnI4KuSlHKB\njHl3Js9vNzEUQipQJbgCgTiWvRJoK3ENwBTMVkKHaqT4x9U4Jk/XZB6Q8MA09ezJ\n3QgiTjTAGcum9E9QiJqMYdWQPWkaBIRRz5cET6HPB48YNXAAUsfmuYsGrnVLYbG+\nUpC6I97VybYHTy2O9XSGoaLeMI9CsFn38ycAxxbWagk5mhclNTP5mezIq6wKSwmr\nX11FW3n1J23fWZn5HJMBsRnUCgzqzX3871IqLYHqRJ/bpZ4h20RhTyPj5c/z7QXp\neSakNQMfbbMcljkha+ZMuVQX1K9aRlVqbmv3ZMWh+OijLYVU2bc=\n=5Io4\n-----END PGP SIGNATURE-----\n" + "vcs": "subversion", + "vcs_url": "http://svn.mycompany.com/svn/myproject", + "vcs_username": "octocat", + "vcs_password": "secret" } } } @@ -329829,235 +340992,168 @@ "content": { "application/json": { "schema": { - "title": "Git Commit", - "description": "Low-level Git commit operations within a repository", + "title": "Import", + "description": "A repository import from an external source.", "type": "object", "properties": { - "sha": { - "description": "SHA for the commit", - "type": "string", - "examples": [ - "7638417db6d59f3c431d3e1f261cc637155684cd" + "vcs": { + "type": [ + "string", + "null" ] }, - "node_id": { + "use_lfs": { + "type": "boolean" + }, + "vcs_url": { + "description": "The URL of the originating repository.", "type": "string" }, - "url": { + "svc_root": { + "type": "string" + }, + "tfvc_project": { + "type": "string" + }, + "status": { "type": "string", - "format": "uri" + "enum": [ + "auth", + "error", + "none", + "detecting", + "choose", + "auth_failed", + "importing", + "mapping", + "waiting_to_push", + "pushing", + "complete", + "setup", + "unknown", + "detection_found_multiple", + "detection_found_nothing", + "detection_needs_auth" + ] }, - "author": { - "description": "Identifying information for the git-user", - "type": "object", - "properties": { - "date": { - "description": "Timestamp of the commit", - "format": "date-time", - "type": "string", - "examples": [ - "2014-08-09T08:02:04+12:00" - ] - }, - "email": { - "type": "string", - "description": "Git email address of the user", - "examples": [ - "monalisa.octocat@example.com" - ] - }, - "name": { - "description": "Name of the git user", - "type": "string", - "examples": [ - "Monalisa Octocat" - ] - } - }, - "required": [ - "email", - "name", - "date" + "status_text": { + "type": [ + "string", + "null" ] }, - "committer": { - "description": "Identifying information for the git-user", - "type": "object", - "properties": { - "date": { - "description": "Timestamp of the commit", - "format": "date-time", - "type": "string", - "examples": [ - "2014-08-09T08:02:04+12:00" - ] - }, - "email": { - "type": "string", - "description": "Git email address of the user", - "examples": [ - "monalisa.octocat@example.com" - ] - }, - "name": { - "description": "Name of the git user", - "type": "string", - "examples": [ - "Monalisa Octocat" - ] - } - }, - "required": [ - "email", - "name", - "date" + "failed_step": { + "type": [ + "string", + "null" ] }, - "message": { - "description": "Message describing the purpose of the commit", - "type": "string", - "examples": [ - "Fix #42" + "error_message": { + "type": [ + "string", + "null" ] }, - "tree": { - "type": "object", - "properties": { - "sha": { - "description": "SHA for the commit", - "type": "string", - "examples": [ - "7638417db6d59f3c431d3e1f261cc637155684cd" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "sha", - "url" + "import_percent": { + "type": [ + "integer", + "null" ] }, - "parents": { + "commit_count": { + "type": [ + "integer", + "null" + ] + }, + "push_percent": { + "type": [ + "integer", + "null" + ] + }, + "has_large_files": { + "type": "boolean" + }, + "large_files_size": { + "type": "integer" + }, + "large_files_count": { + "type": "integer" + }, + "project_choices": { "type": "array", "items": { "type": "object", "properties": { - "sha": { - "description": "SHA for the commit", - "type": "string", - "examples": [ - "7638417db6d59f3c431d3e1f261cc637155684cd" - ] + "vcs": { + "type": "string" }, - "url": { - "type": "string", - "format": "uri" + "tfvc_project": { + "type": "string" }, - "html_url": { - "type": "string", - "format": "uri" + "human_name": { + "type": "string" } - }, - "required": [ - "sha", - "url", - "html_url" - ] + } } }, - "verification": { - "type": "object", - "properties": { - "verified": { - "type": "boolean" - }, - "reason": { - "type": "string" - }, - "signature": { - "type": [ - "string", - "null" - ] - }, - "payload": { - "type": [ - "string", - "null" - ] - }, - "verified_at": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "verified", - "reason", - "signature", - "payload", - "verified_at" + "message": { + "type": "string" + }, + "authors_count": { + "type": [ + "integer", + "null" ] }, + "url": { + "type": "string", + "format": "uri" + }, "html_url": { "type": "string", "format": "uri" + }, + "authors_url": { + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "svn_root": { + "type": "string" } }, "required": [ - "sha", - "node_id", + "vcs", + "vcs_url", + "status", "url", + "repository_url", "html_url", - "author", - "committer", - "tree", - "message", - "parents", - "verification" + "authors_url" ] }, "examples": { "default": { "value": { - "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", - "node_id": "MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==", - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd", - "author": { - "date": "2014-11-07T22:01:45Z", - "name": "Monalisa Octocat", - "email": "octocat@github.com" - }, - "committer": { - "date": "2014-11-07T22:01:45Z", - "name": "Monalisa Octocat", - "email": "octocat@github.com" - }, - "message": "my commit message", - "tree": { - "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/827efc6d56897b048c772eb4087f854f46256132", - "sha": "827efc6d56897b048c772eb4087f854f46256132" - }, - "parents": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7d1b31e74ee336d15cbd21741bc88a537ed063a0", - "sha": "7d1b31e74ee336d15cbd21741bc88a537ed063a0", - "html_url": "https://github.com/octocat/Hello-World/commit/7d1b31e74ee336d15cbd21741bc88a537ed063a0" - } - ], - "verification": { - "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null, - "verified_at": null - }, - "html_url": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" + "vcs": "subversion", + "use_lfs": true, + "vcs_url": "http://svn.mycompany.com/svn/myproject", + "status": "importing", + "status_text": "Importing...", + "has_large_files": false, + "large_files_size": 0, + "large_files_count": 0, + "authors_count": 0, + "commit_count": 1042, + "url": "https://api.github.com/repos/octocat/socm/import", + "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" } } } @@ -330065,7 +341161,7 @@ }, "headers": { "Location": { - "example": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd", + "example": "https://api.github.com/repos/spraints/socm/import", "schema": { "type": "string" } @@ -330173,8 +341269,8 @@ } } }, - "409": { - "description": "Conflict", + "503": { + "description": "Unavailable due to service under maintenance.", "content": { "application/json": { "schema": { @@ -330203,22 +341299,23 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "git", - "subcategory": "commits" - } - } - }, - "/repos/{owner}/{repo}/git/commits/{commit_sha}": { - "get": { - "summary": "Get a commit object", - "description": "Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).\n\nTo get the contents of a commit, see \"[Get a commit](/rest/commits/commits#get-a-commit).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "category": "migrations", + "subcategory": "source-imports", + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12" + }, + "deprecated": true + }, + "patch": { + "summary": "Update an import", + "description": "An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API\nrequest. If no parameters are provided, the import will be restarted.\n\nSome servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will\nhave the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array.\nYou can select the project to import by providing one of the objects in the `project_choices` array in the update request.\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", "tags": [ - "git" + "migrations" ], - "operationId": "git/get-commit", + "operationId": "migrations/update-import", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/git/commits#get-a-commit-object" + "url": "https://docs.github.com/rest/migrations/source-imports#update-an-import" }, "parameters": [ { @@ -330238,459 +341335,353 @@ "schema": { "type": "string" } - }, - { - "name": "commit_sha", - "description": "The SHA of the commit.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true } ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": [ + "object", + "null" + ], + "properties": { + "vcs_username": { + "type": "string", + "description": "The username to provide to the originating repository." + }, + "vcs_password": { + "type": "string", + "description": "The password to provide to the originating repository." + }, + "vcs": { + "type": "string", + "description": "The type of version control system you are migrating from.", + "enum": [ + "subversion", + "tfvc", + "git", + "mercurial" + ], + "examples": [ + "\"git\"" + ] + }, + "tfvc_project": { + "type": "string", + "description": "For a tfvc import, the name of the project that is being imported.", + "examples": [ + "\"project1\"" + ] + } + } + }, + "examples": { + "example-1": { + "summary": "Update authentication for an import", + "value": { + "vcs_username": "octocat", + "vcs_password": "secret" + } + }, + "example-2": { + "summary": "Updating the project choice", + "value": { + "vcs": "tfvc", + "tfvc_project": "project1", + "human_name": "project1 (tfs)" + } + }, + "example-3": { + "summary": "Restarting an import" + } + } + } + } + }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Git Commit", - "description": "Low-level Git commit operations within a repository", + "title": "Import", + "description": "A repository import from an external source.", "type": "object", "properties": { - "sha": { - "description": "SHA for the commit", - "type": "string", - "examples": [ - "7638417db6d59f3c431d3e1f261cc637155684cd" + "vcs": { + "type": [ + "string", + "null" ] }, - "node_id": { + "use_lfs": { + "type": "boolean" + }, + "vcs_url": { + "description": "The URL of the originating repository.", "type": "string" }, - "url": { + "svc_root": { + "type": "string" + }, + "tfvc_project": { + "type": "string" + }, + "status": { "type": "string", - "format": "uri" + "enum": [ + "auth", + "error", + "none", + "detecting", + "choose", + "auth_failed", + "importing", + "mapping", + "waiting_to_push", + "pushing", + "complete", + "setup", + "unknown", + "detection_found_multiple", + "detection_found_nothing", + "detection_needs_auth" + ] }, - "author": { - "description": "Identifying information for the git-user", - "type": "object", - "properties": { - "date": { - "description": "Timestamp of the commit", - "format": "date-time", - "type": "string", - "examples": [ - "2014-08-09T08:02:04+12:00" - ] - }, - "email": { - "type": "string", - "description": "Git email address of the user", - "examples": [ - "monalisa.octocat@example.com" - ] - }, - "name": { - "description": "Name of the git user", - "type": "string", - "examples": [ - "Monalisa Octocat" - ] - } - }, - "required": [ - "email", - "name", - "date" + "status_text": { + "type": [ + "string", + "null" ] }, - "committer": { - "description": "Identifying information for the git-user", - "type": "object", - "properties": { - "date": { - "description": "Timestamp of the commit", - "format": "date-time", - "type": "string", - "examples": [ - "2014-08-09T08:02:04+12:00" - ] - }, - "email": { - "type": "string", - "description": "Git email address of the user", - "examples": [ - "monalisa.octocat@example.com" - ] - }, - "name": { - "description": "Name of the git user", - "type": "string", - "examples": [ - "Monalisa Octocat" - ] - } - }, - "required": [ - "email", - "name", - "date" + "failed_step": { + "type": [ + "string", + "null" ] }, - "message": { - "description": "Message describing the purpose of the commit", - "type": "string", - "examples": [ - "Fix #42" + "error_message": { + "type": [ + "string", + "null" ] }, - "tree": { - "type": "object", - "properties": { - "sha": { - "description": "SHA for the commit", - "type": "string", - "examples": [ - "7638417db6d59f3c431d3e1f261cc637155684cd" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "sha", - "url" + "import_percent": { + "type": [ + "integer", + "null" ] }, - "parents": { + "commit_count": { + "type": [ + "integer", + "null" + ] + }, + "push_percent": { + "type": [ + "integer", + "null" + ] + }, + "has_large_files": { + "type": "boolean" + }, + "large_files_size": { + "type": "integer" + }, + "large_files_count": { + "type": "integer" + }, + "project_choices": { "type": "array", "items": { "type": "object", "properties": { - "sha": { - "description": "SHA for the commit", - "type": "string", - "examples": [ - "7638417db6d59f3c431d3e1f261cc637155684cd" - ] + "vcs": { + "type": "string" }, - "url": { - "type": "string", - "format": "uri" + "tfvc_project": { + "type": "string" }, - "html_url": { - "type": "string", - "format": "uri" + "human_name": { + "type": "string" } - }, - "required": [ - "sha", - "url", - "html_url" - ] + } } }, - "verification": { - "type": "object", - "properties": { - "verified": { - "type": "boolean" - }, - "reason": { - "type": "string" - }, - "signature": { - "type": [ - "string", - "null" - ] - }, - "payload": { - "type": [ - "string", - "null" - ] - }, - "verified_at": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "verified", - "reason", - "signature", - "payload", - "verified_at" + "message": { + "type": "string" + }, + "authors_count": { + "type": [ + "integer", + "null" ] }, + "url": { + "type": "string", + "format": "uri" + }, "html_url": { "type": "string", "format": "uri" + }, + "authors_url": { + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "svn_root": { + "type": "string" } }, "required": [ - "sha", - "node_id", + "vcs", + "vcs_url", + "status", "url", + "repository_url", "html_url", - "author", - "committer", - "tree", - "message", - "parents", - "verification" + "authors_url" ] }, "examples": { - "default": { + "example-1": { + "summary": "Example 1", "value": { - "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", - "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd", - "html_url": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd", - "author": { - "date": "2014-11-07T22:01:45Z", - "name": "Monalisa Octocat", - "email": "octocat@github.com" - }, - "committer": { - "date": "2014-11-07T22:01:45Z", - "name": "Monalisa Octocat", - "email": "octocat@github.com" - }, - "message": "added readme, because im a good github citizen", - "tree": { - "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb", - "sha": "691272480426f78a0138979dd3ce63b77f706feb" - }, - "parents": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5", - "sha": "1acc419d4d6a9ce985db7be48c6349a0475975b5", - "html_url": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" - } - ], - "verification": { - "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null, - "verified_at": 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" + "vcs": "subversion", + "use_lfs": true, + "vcs_url": "http://svn.mycompany.com/svn/myproject", + "status": "detecting", + "url": "https://api.github.com/repos/octocat/socm/import", + "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" } - } - } - } - } - }, - "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" + }, + "example-2": { + "summary": "Example 2", + "value": { + "vcs": "tfvc", + "use_lfs": true, + "vcs_url": "http://tfs.mycompany.com/tfs/myproject", + "tfvc_project": "project1", + "status": "importing", + "status_text": "Importing...", + "has_large_files": false, + "large_files_size": 0, + "large_files_count": 0, + "authors_count": 0, + "commit_count": 1042, + "url": "https://api.github.com/repos/octocat/socm/import", + "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" + } + }, + "example-3": { + "summary": "Response", + "value": { + "vcs": "subversion", + "use_lfs": true, + "vcs_url": "http://svn.mycompany.com/svn/myproject", + "status": "importing", + "status_text": "Importing...", + "has_large_files": false, + "large_files_size": 0, + "large_files_count": 0, + "authors_count": 0, + "commit_count": 1042, + "url": "https://api.github.com/repos/octocat/socm/import", + "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" } } } } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "git", - "subcategory": "commits" - } - } - }, - "/repos/{owner}/{repo}/git/matching-refs/{ref}": { - "get": { - "summary": "List matching references", - "description": "Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array.\n\nWhen you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`.\n\n> [!NOTE]\n> You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nIf you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`.", - "tags": [ - "git" - ], - "operationId": "git/list-matching-refs", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/git/refs#list-matching-references" - }, - "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": "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.", - "in": "path", - "required": true, - "example": "heads/feature-a", - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Git Reference", - "description": "Git references within a repository", - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "object": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "sha": { - "description": "SHA for the reference", - "type": "string", - "minLength": 40, - "maxLength": 40, - "examples": [ - "7638417db6d59f3c431d3e1f261cc637155684cd" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "type", - "sha", - "url" - ] - } - }, - "required": [ - "ref", - "node_id", - "url", - "object" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "ref": "refs/heads/feature-a", - "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlLWE=", - "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-a", - "object": { - "type": "commit", - "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd" - } - }, - { - "ref": "refs/heads/feature-b", - "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlLWI=", - "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-b", - "object": { - "type": "commit", - "sha": "612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac", - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac" - } - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", + } + }, + "503": { + "description": "Unavailable due to service under maintenance.", + "content": { + "application/json": { "schema": { - "type": "string" + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "migrations", + "subcategory": "source-imports", + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12" + }, + "deprecated": true + }, + "delete": { + "summary": "Cancel an import", + "description": "Stop an import for a repository.\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", + "tags": [ + "migrations" + ], + "operationId": "migrations/cancel-import", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/migrations/source-imports#cancel-an-import" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "409": { - "description": "Conflict", + { + "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" + }, + "503": { + "description": "Unavailable due to service under maintenance.", "content": { "application/json": { "schema": { @@ -330719,22 +341710,25 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "git", - "subcategory": "refs" - } + "category": "migrations", + "subcategory": "source-imports", + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12" + }, + "deprecated": true } }, - "/repos/{owner}/{repo}/git/ref/{ref}": { + "/repos/{owner}/{repo}/import/authors": { "get": { - "summary": "Get a reference", - "description": "Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.\n\n> [!NOTE]\n> You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".", + "summary": "Get commit authors", + "description": "Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `.\n\nThis endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information.\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", "tags": [ - "git" + "migrations" ], - "operationId": "git/get-ref", + "operationId": "migrations/get-commit-authors", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/git/refs#get-a-reference" + "url": "https://docs.github.com/rest/migrations/source-imports#get-commit-authors" }, "parameters": [ { @@ -330756,15 +341750,13 @@ } }, { - "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.", - "in": "path", - "required": true, - "example": "heads/feature-a", + "name": "since", + "description": "A user ID. Only return users with an ID greater than this ID.", + "in": "query", + "required": false, "schema": { - "type": "string" - }, - "x-multi-segment": true + "type": "integer" + } } ], "responses": { @@ -330773,66 +341765,78 @@ "content": { "application/json": { "schema": { - "title": "Git Reference", - "description": "Git references within a repository", - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "object": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "sha": { - "description": "SHA for the reference", - "type": "string", - "minLength": 40, - "maxLength": 40, - "examples": [ - "7638417db6d59f3c431d3e1f261cc637155684cd" - ] - }, - "url": { - "type": "string", - "format": "uri" - } + "type": "array", + "items": { + "title": "Porter Author", + "description": "Porter Author", + "type": "object", + "properties": { + "id": { + "type": "integer" }, - "required": [ - "type", - "sha", - "url" - ] - } - }, - "required": [ - "ref", - "node_id", - "url", - "object" - ] + "remote_id": { + "type": "string" + }, + "remote_name": { + "type": "string" + }, + "email": { + "type": "string" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "import_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "remote_id", + "remote_name", + "email", + "name", + "url", + "import_url" + ] + } }, "examples": { "default": { - "value": { - "ref": "refs/heads/featureA", - "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==", - "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA", - "object": { - "type": "commit", - "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd" + "value": [ + { + "id": 2268557, + "remote_id": "nobody@fc7da526-431c-80fe-3c8c-c148ff18d7ef", + "remote_name": "nobody", + "email": "hubot@github.com", + "name": "Hubot", + "url": "https://api.github.com/repos/octocat/socm/import/authors/2268557", + "import_url": "https://api.github.com/repos/octocat/socm/import" + }, + { + "id": 2268558, + "remote_id": "svner@fc7da526-431c-80fe-3c8c-c148ff18d7ef", + "remote_name": "svner", + "email": "svner@fc7da526-431c-80fe-3c8c-c148ff18d7ef", + "name": "svner", + "url": "https://api.github.com/repos/octocat/socm/import/authors/2268558", + "import_url": "https://api.github.com/repos/octocat/socm/import" + }, + { + "id": 2268559, + "remote_id": "svner@example.com@fc7da526-431c-80fe-3c8c-c148ff18d7ef", + "remote_name": "svner@example.com", + "email": "svner@example.com@fc7da526-431c-80fe-3c8c-c148ff18d7ef", + "name": "svner@example.com", + "url": "https://api.github.com/repos/octocat/socm/import/authors/2268559", + "import_url": "https://api.github.com/repos/octocat/socm/import" } - } + ] } } } @@ -330864,8 +341868,8 @@ } } }, - "409": { - "description": "Conflict", + "503": { + "description": "Unavailable due to service under maintenance.", "content": { "application/json": { "schema": { @@ -330894,22 +341898,25 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "git", - "subcategory": "refs" - } + "category": "migrations", + "subcategory": "source-imports", + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12" + }, + "deprecated": true } }, - "/repos/{owner}/{repo}/git/refs": { - "post": { - "summary": "Create a reference", - "description": "Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.", + "/repos/{owner}/{repo}/import/authors/{author_id}": { + "patch": { + "summary": "Map a commit author", + "description": "Update an author's identity for the import. Your application can continue updating authors any time before you push\nnew commits to the repository.\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", "tags": [ - "git" + "migrations" ], - "operationId": "git/create-ref", + "operationId": "migrations/map-commit-author", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/git/refs#create-a-reference" + "url": "https://docs.github.com/rest/migrations/source-imports#map-a-commit-author" }, "parameters": [ { @@ -330929,34 +341936,39 @@ "schema": { "type": "string" } + }, + { + "name": "author_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "requestBody": { - "required": true, + "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { - "ref": { + "email": { "type": "string", - "description": "The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected." + "description": "The new Git author email." }, - "sha": { + "name": { "type": "string", - "description": "The SHA1 value for this reference." + "description": "The new Git author name." } }, - "required": [ - "ref", - "sha" - ] + "additionalProperties": false }, "examples": { "default": { "value": { - "ref": "refs/heads/featureA", - "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd" + "email": "hubot@github.com", + "name": "Hubot the Robot" } } } @@ -330964,82 +341976,63 @@ } }, "responses": { - "201": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Git Reference", - "description": "Git references within a repository", + "title": "Porter Author", + "description": "Porter Author", "type": "object", "properties": { - "ref": { + "id": { + "type": "integer" + }, + "remote_id": { "type": "string" }, - "node_id": { + "remote_name": { + "type": "string" + }, + "email": { + "type": "string" + }, + "name": { "type": "string" }, "url": { "type": "string", "format": "uri" }, - "object": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "sha": { - "description": "SHA for the reference", - "type": "string", - "minLength": 40, - "maxLength": 40, - "examples": [ - "7638417db6d59f3c431d3e1f261cc637155684cd" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "type", - "sha", - "url" - ] + "import_url": { + "type": "string", + "format": "uri" } }, "required": [ - "ref", - "node_id", + "id", + "remote_id", + "remote_name", + "email", + "name", "url", - "object" + "import_url" ] }, "examples": { "default": { "value": { - "ref": "refs/heads/featureA", - "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==", - "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA", - "object": { - "type": "commit", - "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd" - } + "id": 2268557, + "remote_id": "nobody@fc7da526-431c-80fe-3c8c-c148ff18d7ef", + "remote_name": "nobody", + "email": "hubot@github.com", + "name": "Hubot", + "url": "https://api.github.com/repos/octocat/socm/import/authors/2268557", + "import_url": "https://api.github.com/repos/octocat/socm/import" } } } } - }, - "headers": { - "Location": { - "example": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA", - "schema": { - "type": "string" - } - } } }, "422": { @@ -331117,8 +342110,34 @@ } } }, - "409": { - "description": "Conflict", + "404": { + "description": "Resource not found", + "content": { + "application/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": "Unavailable due to service under maintenance.", "content": { "application/json": { "schema": { @@ -331147,22 +342166,25 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "git", - "subcategory": "refs" - } + "category": "migrations", + "subcategory": "source-imports", + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12" + }, + "deprecated": true } }, - "/repos/{owner}/{repo}/git/refs/{ref}": { - "patch": { - "summary": "Update a reference", - "description": "Updates the provided reference to point to a new SHA. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.", + "/repos/{owner}/{repo}/import/large_files": { + "get": { + "summary": "Get large files", + "description": "List files larger than 100MB found during the import\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", "tags": [ - "git" + "migrations" ], - "operationId": "git/update-ref", + "operationId": "migrations/get-large-files", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/git/refs#update-a-reference" + "url": "https://docs.github.com/rest/migrations/source-imports#get-large-files" }, "parameters": [ { @@ -331182,17 +342204,136 @@ "schema": { "type": "string" } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Porter Large File", + "description": "Porter Large File", + "type": "object", + "properties": { + "ref_name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "oid": { + "type": "string" + }, + "size": { + "type": "integer" + } + }, + "required": [ + "oid", + "path", + "ref_name", + "size" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "ref_name": "refs/heads/master", + "path": "foo/bar/1", + "oid": "d3d9446802a44259755d38e6d163e820", + "size": 10485760 + }, + { + "ref_name": "refs/heads/master", + "path": "foo/bar/2", + "oid": "6512bd43d9caa6e02c990b0a82652dca", + "size": 11534336 + }, + { + "ref_name": "refs/heads/master", + "path": "foo/bar/3", + "oid": "c20ad4d76fe97759aa27a0c99bff6710", + "size": 12582912 + } + ] + } + } + } + } + }, + "503": { + "description": "Unavailable due to service under maintenance.", + "content": { + "application/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": "migrations", + "subcategory": "source-imports", + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12" + }, + "deprecated": true + } + }, + "/repos/{owner}/{repo}/import/lfs": { + "patch": { + "summary": "Update Git LFS preference", + "description": "You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability\nis powered by [Git LFS](https://git-lfs.com).\n\nYou can learn more about our LFS feature and working with large files [on our help\nsite](https://docs.github.com/repositories/working-with-files/managing-large-files).\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", + "tags": [ + "migrations" + ], + "operationId": "migrations/set-lfs-preference", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, { - "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.", + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", "in": "path", "required": true, - "example": "heads/feature-a", "schema": { "type": "string" - }, - "x-multi-segment": true + } } ], "requestBody": { @@ -331202,25 +342343,23 @@ "schema": { "type": "object", "properties": { - "sha": { + "use_lfs": { "type": "string", - "description": "The SHA1 value to set this reference to" - }, - "force": { - "type": "boolean", - "description": "Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work.", - "default": false + "description": "Whether to store large files during the import. `opt_in` means large files will be stored using Git LFS. `opt_out` means large files will be removed during the import.", + "enum": [ + "opt_in", + "opt_out" + ] } }, "required": [ - "sha" + "use_lfs" ] }, "examples": { "default": { "value": { - "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", - "force": true + "use_lfs": "opt_in" } } } @@ -331233,65 +342372,167 @@ "content": { "application/json": { "schema": { - "title": "Git Reference", - "description": "Git references within a repository", + "title": "Import", + "description": "A repository import from an external source.", "type": "object", "properties": { - "ref": { + "vcs": { + "type": [ + "string", + "null" + ] + }, + "use_lfs": { + "type": "boolean" + }, + "vcs_url": { + "description": "The URL of the originating repository.", "type": "string" }, - "node_id": { + "svc_root": { "type": "string" }, - "url": { + "tfvc_project": { + "type": "string" + }, + "status": { "type": "string", - "format": "uri" + "enum": [ + "auth", + "error", + "none", + "detecting", + "choose", + "auth_failed", + "importing", + "mapping", + "waiting_to_push", + "pushing", + "complete", + "setup", + "unknown", + "detection_found_multiple", + "detection_found_nothing", + "detection_needs_auth" + ] }, - "object": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "sha": { - "description": "SHA for the reference", - "type": "string", - "minLength": 40, - "maxLength": 40, - "examples": [ - "7638417db6d59f3c431d3e1f261cc637155684cd" - ] - }, - "url": { - "type": "string", - "format": "uri" + "status_text": { + "type": [ + "string", + "null" + ] + }, + "failed_step": { + "type": [ + "string", + "null" + ] + }, + "error_message": { + "type": [ + "string", + "null" + ] + }, + "import_percent": { + "type": [ + "integer", + "null" + ] + }, + "commit_count": { + "type": [ + "integer", + "null" + ] + }, + "push_percent": { + "type": [ + "integer", + "null" + ] + }, + "has_large_files": { + "type": "boolean" + }, + "large_files_size": { + "type": "integer" + }, + "large_files_count": { + "type": "integer" + }, + "project_choices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "vcs": { + "type": "string" + }, + "tfvc_project": { + "type": "string" + }, + "human_name": { + "type": "string" + } } - }, - "required": [ - "type", - "sha", - "url" + } + }, + "message": { + "type": "string" + }, + "authors_count": { + "type": [ + "integer", + "null" ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "authors_url": { + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "svn_root": { + "type": "string" } }, "required": [ - "ref", - "node_id", + "vcs", + "vcs_url", + "status", "url", - "object" + "repository_url", + "html_url", + "authors_url" ] }, "examples": { "default": { "value": { - "ref": "refs/heads/featureA", - "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==", - "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA", - "object": { - "type": "commit", - "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd" - } + "vcs": "subversion", + "use_lfs": true, + "vcs_url": "http://svn.mycompany.com/svn/myproject", + "status": "complete", + "status_text": "Done", + "has_large_files": true, + "large_files_size": 132331036, + "large_files_count": 1, + "authors_count": 4, + "url": "https://api.github.com/repos/octocat/socm/import", + "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" } } } @@ -331373,8 +342614,8 @@ } } }, - "409": { - "description": "Conflict", + "503": { + "description": "Unavailable due to service under maintenance.", "content": { "application/json": { "schema": { @@ -331403,105 +342644,25 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "git", - "subcategory": "refs" - } - }, - "delete": { - "summary": "Delete a reference", - "description": "Deletes the provided reference.", - "tags": [ - "git" - ], - "operationId": "git/delete-ref", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/git/refs#delete-a-reference" - }, - "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": "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.", - "in": "path", - "required": true, - "example": "heads/feature-a", - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "responses": { - "204": { - "description": "Response" - }, - "422": { - "description": "Validation failed, an attempt was made to delete the default branch, or the endpoint has been spammed." - }, - "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" - } - } - } - } - } - } + "category": "migrations", + "subcategory": "source-imports", + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12" }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "git", - "subcategory": "refs" - } + "deprecated": true } }, - "/repos/{owner}/{repo}/git/tags": { - "post": { - "summary": "Create a tag object", - "description": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "/repos/{owner}/{repo}/installation": { + "get": { + "summary": "Get a repository installation for the authenticated app", + "description": "Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.\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": [ - "git" + "apps" ], - "operationId": "git/create-tag", + "operationId": "apps/get-repo-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/git/tags#create-a-tag-object" + "url": "https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app" }, "parameters": [ { @@ -331523,265 +342684,1058 @@ } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "tag": { - "type": "string", - "description": "The tag's name. This is typically a version (e.g., \"v0.0.1\")." - }, - "message": { - "type": "string", - "description": "The tag message." - }, - "object": { - "type": "string", - "description": "The SHA of the git object this is tagging." - }, - "type": { - "type": "string", - "description": "The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`.", - "enum": [ - "commit", - "tree", - "blob" - ] - }, - "tagger": { - "type": "object", - "description": "An object with information about the individual creating the tag.", - "properties": { - "name": { - "type": "string", - "description": "The name of the author of the tag" - }, - "email": { - "type": "string", - "description": "The email of the author of the tag" - }, - "date": { - "type": "string", - "format": "date-time", - "description": "When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." - } - }, - "required": [ - "name", - "email" - ] - } - }, - "required": [ - "tag", - "message", - "object", - "type" - ] - }, - "examples": { - "default": { - "value": { - "tag": "v0.0.1", - "message": "initial version", - "object": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c", - "type": "commit", - "tagger": { - "name": "Monalisa Octocat", - "email": "octocat@github.com", - "date": "2011-06-17T14:53:35-07:00" - } - } - } - } - } - } - }, "responses": { - "201": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Git Tag", - "description": "Metadata for a Git tag", + "title": "Installation", + "description": "Installation", "type": "object", "properties": { - "node_id": { - "type": "string", + "id": { + "description": "The ID of the installation.", + "type": "integer", "examples": [ - "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==" + 1 ] }, - "tag": { - "description": "Name of the tag", + "account": { + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "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" + ] + } + ], + "type": [ + "null", + "object" + ] + }, + "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", "examples": [ - "v0.0.1" + "https://api.github.com/app/installations/1/access_tokens" ] }, - "sha": { + "repositories_url": { "type": "string", + "format": "uri", "examples": [ - "940bd336248efae0f9ee5bc7b2d5c985887b16ac" + "https://api.github.com/installation/repositories" ] }, - "url": { - "description": "URL for the tag", + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/repositories/42/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac" + "https://github.com/organizations/github/settings/installations/1" ] }, - "message": { - "description": "Message describing the purpose of the tag", + "app_id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "client_id": { "type": "string", "examples": [ - "Initial public release" + "Iv1.ab1112223334445c" ] }, - "tagger": { - "type": "object", - "properties": { - "date": { - "type": "string" - }, - "email": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "required": [ - "date", - "email", - "name" + "target_id": { + "description": "The ID of the user or organization this token is being scoped to.", + "type": "integer" + }, + "target_type": { + "type": "string", + "examples": [ + "Organization" ] }, - "object": { + "permissions": { + "title": "App Permissions", "type": "object", + "description": "The permissions granted to the user access token.", "properties": { - "sha": { - "type": "string" + "actions": { + "type": "string", + "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", + "enum": [ + "read", + "write" + ] }, - "type": { - "type": "string" + "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" + ] }, - "url": { + "checks": { "type": "string", - "format": "uri" - } - }, - "required": [ - "sha", - "type", - "url" - ] - }, - "verification": { - "title": "Verification", - "type": "object", - "properties": { - "verified": { - "type": "boolean" + "description": "The level of permission to grant the access token for checks on code.", + "enum": [ + "read", + "write" + ] }, - "reason": { - "type": "string" + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] }, - "payload": { - "type": [ - "string", - "null" + "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" ] }, - "signature": { - "type": [ - "string", - "null" + "dependabot_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" ] }, - "verified_at": { - "type": [ - "string", - "null" + "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" ] } }, - "required": [ - "verified", - "reason", - "payload", - "signature", - "verified_at" + "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", + "null" + ], + "examples": [ + "config.yaml" + ] + }, + "has_multiple_single_files": { + "type": "boolean", + "examples": [ + true + ] + }, + "single_file_paths": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ] + }, + "app_slug": { + "type": "string", + "examples": [ + "github-actions" + ] + }, + "suspended_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "suspended_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "contact_email": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" ] } }, "required": [ - "sha", - "url", - "node_id", - "tagger", - "object", - "tag", - "message" + "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": { - "node_id": "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==", - "tag": "v0.0.1", - "sha": "940bd336248efae0f9ee5bc7b2d5c985887b16ac", - "url": "https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac", - "message": "initial version", - "tagger": { - "name": "Monalisa Octocat", - "email": "octocat@github.com", - "date": "2014-11-07T22:01:45Z" + "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 }, - "object": { - "type": "commit", - "sha": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c", - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c" + "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" }, - "verification": { - "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null, - "verified_at": null - } + "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 } } } } - }, - "headers": { - "Location": { - "example": "https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac", - "schema": { - "type": "string" - } - } } }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + "301": { + "description": "Moved permanently", "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" @@ -331789,64 +343743,19 @@ "documentation_url": { "type": "string" }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } }, - "409": { - "description": "Conflict", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -331874,23 +343783,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "git", - "subcategory": "tags" + "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "apps" } } }, - "/repos/{owner}/{repo}/git/tags/{tag_sha}": { + "/repos/{owner}/{repo}/interaction-limits": { "get": { - "summary": "Get a tag", - "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "summary": "Get interaction restrictions for a repository", + "description": "Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response.", "tags": [ - "git" + "interactions" ], - "operationId": "git/get-tag", + "operationId": "interactions/get-restrictions-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/git/tags#get-a-tag" + "url": "https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository" }, "parameters": [ { @@ -331910,14 +343819,6 @@ "schema": { "type": "string" } - }, - { - "name": "tag_sha", - "in": "path", - "required": true, - "schema": { - "type": "string" - } } ], "responses": { @@ -331926,208 +343827,57 @@ "content": { "application/json": { "schema": { - "title": "Git Tag", - "description": "Metadata for a Git tag", - "type": "object", - "properties": { - "node_id": { - "type": "string", - "examples": [ - "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==" - ] - }, - "tag": { - "description": "Name of the tag", - "type": "string", - "examples": [ - "v0.0.1" - ] - }, - "sha": { - "type": "string", - "examples": [ - "940bd336248efae0f9ee5bc7b2d5c985887b16ac" - ] - }, - "url": { - "description": "URL for the tag", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac" - ] - }, - "message": { - "description": "Message describing the purpose of the tag", - "type": "string", - "examples": [ - "Initial public release" - ] - }, - "tagger": { - "type": "object", - "properties": { - "date": { - "type": "string" - }, - "email": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "required": [ - "date", - "email", - "name" - ] - }, - "object": { + "anyOf": [ + { + "title": "Interaction Limits", + "description": "Interaction limit settings.", "type": "object", "properties": { - "sha": { - "type": "string" - }, - "type": { - "type": "string" - }, - "url": { + "limit": { "type": "string", - "format": "uri" - } - }, - "required": [ - "sha", - "type", - "url" - ] - }, - "verification": { - "title": "Verification", - "type": "object", - "properties": { - "verified": { - "type": "boolean" - }, - "reason": { - "type": "string" - }, - "payload": { - "type": [ - "string", - "null" + "description": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.", + "enum": [ + "existing_users", + "contributors_only", + "collaborators_only" + ], + "examples": [ + "collaborators_only" ] }, - "signature": { - "type": [ - "string", - "null" + "origin": { + "type": "string", + "examples": [ + "repository" ] }, - "verified_at": { - "type": [ - "string", - "null" + "expires_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2018-08-17T04:18:39Z" ] } }, "required": [ - "verified", - "reason", - "payload", - "signature", - "verified_at" + "limit", + "origin", + "expires_at" ] + }, + { + "type": "object", + "properties": {}, + "additionalProperties": false } - }, - "required": [ - "sha", - "url", - "node_id", - "tagger", - "object", - "tag", - "message" ] }, "examples": { "default": { "value": { - "node_id": "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==", - "tag": "v0.0.1", - "sha": "940bd336248efae0f9ee5bc7b2d5c985887b16ac", - "url": "https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac", - "message": "initial version", - "tagger": { - "name": "Monalisa Octocat", - "email": "octocat@github.com", - "date": "2014-11-07T22:01:45Z" - }, - "object": { - "type": "commit", - "sha": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c", - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c" - }, - "verification": { - "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null, - "verified_at": 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" - } - } - } - } - } - }, - "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" + "limit": "collaborators_only", + "origin": "repository", + "expires_at": "2018-08-17T04:18:39Z" } } } @@ -332138,22 +343888,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "git", - "subcategory": "tags" + "category": "interactions", + "subcategory": "repos" } - } - }, - "/repos/{owner}/{repo}/git/trees": { - "post": { - "summary": "Create a tree", - "description": "The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.\n\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"[Create a commit](https://docs.github.com/rest/git/commits#create-a-commit)\" and \"[Update a reference](https://docs.github.com/rest/git/refs#update-a-reference).\"\n\nReturns an error if you try to delete a file that does not exist.", + }, + "put": { + "summary": "Set interaction restrictions for a repository", + "description": "Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository.", "tags": [ - "git" + "interactions" ], - "operationId": "git/create-tree", + "operationId": "interactions/set-restrictions-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/git/trees#create-a-tree" + "url": "https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository" }, "parameters": [ { @@ -332180,73 +343928,47 @@ "content": { "application/json": { "schema": { + "title": "Interaction Restrictions", + "description": "Limit interactions to a specific type of user for a specified duration", "type": "object", "properties": { - "tree": { - "type": "array", - "description": "Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure.", - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file referenced in the tree." - }, - "mode": { - "type": "string", - "description": "The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink.", - "enum": [ - "100644", - "100755", - "040000", - "160000", - "120000" - ] - }, - "type": { - "type": "string", - "description": "Either `blob`, `tree`, or `commit`.", - "enum": [ - "blob", - "tree", - "commit" - ] - }, - "sha": { - "type": [ - "string", - "null" - ], - "description": "The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error." - }, - "content": { - "type": "string", - "description": "The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error." - } - } - } + "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.", + "enum": [ + "existing_users", + "contributors_only", + "collaborators_only" + ], + "examples": [ + "collaborators_only" + ] }, - "base_tree": { + "expiry": { "type": "string", - "description": "The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit." + "description": "The duration of the interaction restriction. Default: `one_day`.", + "enum": [ + "one_day", + "three_days", + "one_week", + "one_month", + "six_months" + ], + "examples": [ + "one_month" + ] } }, "required": [ - "tree" + "limit" ] }, "examples": { "default": { + "summary": "Example request body", "value": { - "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312", - "tree": [ - { - "path": "file.rb", - "mode": "100644", - "type": "blob", - "sha": "44b4fc6d56897b048c772eb4087f854f46256132" - } - ] + "limit": "collaborators_only", + "expiry": "one_day" } } } @@ -332254,244 +343976,53 @@ } }, "responses": { - "201": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Git Tree", - "description": "The hierarchy between files in a Git repository.", + "title": "Interaction Limits", + "description": "Interaction limit settings.", "type": "object", "properties": { - "sha": { - "type": "string" - }, - "url": { + "limit": { "type": "string", - "format": "uri" + "description": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.", + "enum": [ + "existing_users", + "contributors_only", + "collaborators_only" + ], + "examples": [ + "collaborators_only" + ] }, - "truncated": { - "type": "boolean" + "origin": { + "type": "string", + "examples": [ + "repository" + ] }, - "tree": { - "description": "Objects specifying a tree structure", - "type": "array", - "items": { - "type": "object", - "required": [ - "path", - "mode", - "type", - "sha" - ], - "properties": { - "path": { - "type": "string", - "examples": [ - "test/file.rb" - ] - }, - "mode": { - "type": "string", - "examples": [ - "040000" - ] - }, - "type": { - "type": "string", - "examples": [ - "tree" - ] - }, - "sha": { - "type": "string", - "examples": [ - "23f6827669e43831def8a7ad935069c8bd418261" - ] - }, - "size": { - "type": "integer", - "examples": [ - 12 - ] - }, - "url": { - "type": "string", - "examples": [ - "https://api.github.com/repos/owner-482f3203ecf01f67e9deb18e/BBB_Private_Repo/git/blobs/23f6827669e43831def8a7ad935069c8bd418261" - ] - } - } - }, + "expires_at": { + "type": "string", + "format": "date-time", "examples": [ - { - "path": "file.rb", - "mode": "100644", - "type": "blob", - "size": 30, - "sha": "44b4fc6d56897b048c772eb4087f854f46256132", - "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132" - } + "2018-08-17T04:18:39Z" ] } }, "required": [ - "sha", - "tree", - "truncated" + "limit", + "origin", + "expires_at" ] }, "examples": { "default": { "value": { - "sha": "cd8274d15fa3ae2ab983129fb037999f264ba9a7", - "url": "https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7", - "tree": [ - { - "path": "file.rb", - "mode": "100644", - "type": "blob", - "size": 132, - "sha": "7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b", - "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b" - } - ], - "truncated": true - } - } - } - } - }, - "headers": { - "Location": { - "example": "https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7", - "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", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "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" - } - } - } - } - } - }, - "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" + "limit": "collaborators_only", + "origin": "repository", + "expires_at": "2018-08-17T04:18:39Z" } } } @@ -332499,51 +344030,26 @@ } }, "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" - } - } - } - } - } + "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "git", - "subcategory": "trees" + "category": "interactions", + "subcategory": "repos" } - } - }, - "/repos/{owner}/{repo}/git/trees/{tree_sha}": { - "get": { - "summary": "Get a tree", - "description": "Returns a single tree using the SHA1 value or ref name for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.\n\n> [!NOTE]\n> The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.", + }, + "delete": { + "summary": "Remove interaction restrictions for a repository", + "description": "Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository.", "tags": [ - "git" + "interactions" ], - "operationId": "git/get-tree", + "operationId": "interactions/remove-restrictions-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/git/trees#get-a-tree" + "url": "https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository" }, "parameters": [ { @@ -332563,318 +344069,35 @@ "schema": { "type": "string" } - }, - { - "name": "tree_sha", - "description": "The SHA1 value or ref (branch or tag) name of the tree.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - }, - { - "name": "recursive", - "description": "Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` to any of the following will enable returning objects or subtrees: `0`, `1`, `\"true\"`, and `\"false\"`. Omit this parameter to prevent recursively returning objects or subtrees.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } } ], "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Git Tree", - "description": "The hierarchy between files in a Git repository.", - "type": "object", - "properties": { - "sha": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "truncated": { - "type": "boolean" - }, - "tree": { - "description": "Objects specifying a tree structure", - "type": "array", - "items": { - "type": "object", - "required": [ - "path", - "mode", - "type", - "sha" - ], - "properties": { - "path": { - "type": "string", - "examples": [ - "test/file.rb" - ] - }, - "mode": { - "type": "string", - "examples": [ - "040000" - ] - }, - "type": { - "type": "string", - "examples": [ - "tree" - ] - }, - "sha": { - "type": "string", - "examples": [ - "23f6827669e43831def8a7ad935069c8bd418261" - ] - }, - "size": { - "type": "integer", - "examples": [ - 12 - ] - }, - "url": { - "type": "string", - "examples": [ - "https://api.github.com/repos/owner-482f3203ecf01f67e9deb18e/BBB_Private_Repo/git/blobs/23f6827669e43831def8a7ad935069c8bd418261" - ] - } - } - }, - "examples": [ - { - "path": "file.rb", - "mode": "100644", - "type": "blob", - "size": 30, - "sha": "44b4fc6d56897b048c772eb4087f854f46256132", - "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132" - } - ] - } - }, - "required": [ - "sha", - "tree", - "truncated" - ] - }, - "examples": { - "default-response": { - "summary": "Default response", - "value": { - "sha": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312", - "url": "https://api.github.com/repos/octocat/Hello-World/trees/9fb037999f264ba9a7fc6274d15fa3ae2ab98312", - "tree": [ - { - "path": "file.rb", - "mode": "100644", - "type": "blob", - "size": 30, - "sha": "44b4fc6d56897b048c772eb4087f854f46256132", - "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132" - }, - { - "path": "subdir", - "mode": "040000", - "type": "tree", - "sha": "f484d249c660418515fb01c2b9662073663c242e", - "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/f484d249c660418515fb01c2b9662073663c242e" - }, - { - "path": "exec_file", - "mode": "100755", - "type": "blob", - "size": 75, - "sha": "45b983be36b73c0788dc9cbcb76cbb80fc7bb057", - "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/45b983be36b73c0788dc9cbcb76cbb80fc7bb057" - } - ], - "truncated": false - } - }, - "response-recursively-retrieving-a-tree": { - "summary": "Response recursively retrieving a tree", - "value": { - "sha": "fc6274d15fa3ae2ab983129fb037999f264ba9a7", - "url": "https://api.github.com/repos/octocat/Hello-World/trees/fc6274d15fa3ae2ab983129fb037999f264ba9a7", - "tree": [ - { - "path": "subdir/file.txt", - "mode": "100644", - "type": "blob", - "size": 132, - "sha": "7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b", - "url": "https://api.github.com/repos/octocat/Hello-World/git/7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b" - } - ], - "truncated": false - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/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" }, "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" - } - } - } - } - } + "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "git", - "subcategory": "trees" + "category": "interactions", + "subcategory": "repos" } } }, - "/repos/{owner}/{repo}/hooks": { + "/repos/{owner}/{repo}/invitations": { "get": { - "summary": "List repository webhooks", - "description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.", + "summary": "List repository invitations", + "description": "When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.", "tags": [ "repos" ], - "operationId": "repos/list-webhooks", + "operationId": "repos/list-invitations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/webhooks#list-repository-webhooks" + "url": "https://docs.github.com/rest/collaborators/invitations#list-repository-invitations" }, "parameters": [ { @@ -332922,173 +344145,1274 @@ "schema": { "type": "array", "items": { - "title": "Webhook", - "description": "Webhooks for repositories.", + "title": "Repository Invitation", + "description": "Repository invitations let you manage who you collaborate with.", "type": "object", "properties": { - "type": { - "type": "string" - }, "id": { - "description": "Unique identifier of the webhook.", + "description": "Unique identifier of the repository invitation.", "type": "integer", + "format": "int64", "examples": [ 42 ] }, - "name": { - "description": "The name of a valid service, use 'web' for a webhook.", - "type": "string", - "examples": [ - "web" - ] - }, - "active": { - "description": "Determines whether the hook is actually triggered on pushes.", - "type": "boolean", - "examples": [ - true + "repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "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", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# 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", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "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" ] }, - "events": { - "description": "Determines what events the hook is triggered for. Default: ['push'].", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "push", - "pull_request" + "invitee": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } ] }, - "config": { - "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.", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"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).", - "examples": [ - "\"********\"" - ] + "inviter": { + "anyOf": [ + { + "type": "null" }, - "insecure_ssl": { - "oneOf": [ - { + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { "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.**", "examples": [ - "\"0\"" + "octocat" ] }, - { - "type": "number" + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] } - } + ] }, - "updated_at": { + "permissions": { + "description": "The permission associated with the invitation.", "type": "string", - "format": "date-time", + "enum": [ + "read", + "write", + "admin", + "triage", + "maintain" + ], "examples": [ - "2011-09-06T20:39:23Z" + "read" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2011-09-06T17:26:27Z" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks/1" + "2016-06-13T14:52:50-05:00" ] }, - "test_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks/1/test" - ] + "expired": { + "description": "Whether or not the invitation has expired", + "type": "boolean" }, - "ping_url": { + "url": { + "description": "URL for the repository invitation", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks/1/pings" + "https://api.github.com/user/repository-invitations/1" ] }, - "deliveries_url": { + "html_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries" + "https://github.com/octocat/Hello-World/invitations" ] }, - "last_response": { - "title": "Hook Response", - "type": "object", - "properties": { - "code": { - "type": [ - "integer", - "null" - ] - }, - "status": { - "type": [ - "string", - "null" - ] - }, - "message": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "code", - "status", - "message" - ] + "node_id": { + "type": "string" } }, "required": [ "id", + "node_id", + "permissions", + "inviter", + "invitee", + "repository", "url", - "type", - "name", - "active", - "events", - "config", - "ping_url", - "created_at", - "updated_at", - "last_response", - "test_url" + "html_url", + "created_at" ] } }, @@ -333096,30 +345420,121 @@ "default": { "value": [ { - "type": "Repository", - "id": 12345678, - "name": "web", - "active": true, - "events": [ - "push", - "pull_request" - ], - "config": { - "content_type": "json", - "insecure_ssl": "0", - "url": "https://example.com/webhook" + "id": 1, + "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" }, - "updated_at": "2019-06-03T00:57:16Z", - "created_at": "2019-06-03T00:57:16Z", - "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", - "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test", - "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings", - "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", - "last_response": { - "code": null, - "status": "unused", - "message": null - } + "invitee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "inviter": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "permissions": "write", + "created_at": "2016-06-13T14:52:50-05:00", + "url": "https://api.github.com/user/repository_invitations/1296269", + "html_url": "https://github.com/octocat/Hello-World/invitations", + "node_id": "MDQ6VXNlcjE=" } ] } @@ -333134,51 +345549,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": "repos", - "subcategory": "webhooks" + "category": "collaborators", + "subcategory": "invitations" } - }, - "post": { - "summary": "Create a repository webhook", - "description": "Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can\nshare the same `config` as long as those webhooks do not have any `events` that overlap.", + } + }, + "/repos/{owner}/{repo}/invitations/{invitation_id}": { + "patch": { + "summary": "Update a repository invitation", + "description": "", "tags": [ "repos" ], - "operationId": "repos/create-webhook", + "operationId": "repos/update-invitation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook" + "url": "https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation" }, "parameters": [ { @@ -333198,6 +345589,15 @@ "schema": { "type": "string" } + }, + { + "name": "invitation_id", + "description": "The unique identifier of the invitation.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "requestBody": { @@ -333205,89 +345605,26 @@ "content": { "application/json": { "schema": { - "type": [ - "object", - "null" - ], + "type": "object", "properties": { - "name": { + "permissions": { "type": "string", - "description": "Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `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.", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"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).", - "examples": [ - "\"********\"" - ] - }, - "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.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ] - } - } - }, - "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 + "description": "The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`.", + "enum": [ + "read", + "write", + "maintain", + "triage", + "admin" + ] } - }, - "additionalProperties": false + } }, "examples": { "default": { + "summary": "Example request body", "value": { - "name": "web", - "active": true, - "events": [ - "push", - "pull_request" - ], - "config": { - "url": "https://example.com/webhook", - "content_type": "json", - "insecure_ssl": "0" - } + "permissions": "write" } } } @@ -333295,1077 +345632,1400 @@ } }, "responses": { - "201": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Webhook", - "description": "Webhooks for repositories.", + "title": "Repository Invitation", + "description": "Repository invitations let you manage who you collaborate with.", "type": "object", "properties": { - "type": { - "type": "string" - }, "id": { - "description": "Unique identifier of the webhook.", + "description": "Unique identifier of the repository invitation.", "type": "integer", + "format": "int64", "examples": [ 42 ] }, - "name": { - "description": "The name of a valid service, use 'web' for a webhook.", - "type": "string", - "examples": [ - "web" - ] - }, - "active": { - "description": "Determines whether the hook is actually triggered on pushes.", - "type": "boolean", - "examples": [ - true - ] - }, - "events": { - "description": "Determines what events the hook is triggered for. Default: ['push'].", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "push", - "pull_request" - ] - }, - "config": { - "title": "Webhook Configuration", - "description": "Configuration object of the webhook", + "repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { - "url": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] + }, + "node_id": { "type": "string", - "description": "The URL to which the payloads will be delivered.", - "format": "uri", "examples": [ - "https://example.com/webhook" + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "content_type": { + "name": { "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "examples": [ - "\"json\"" + "Hello-World" ] }, - "secret": { + "full_name": { "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).", "examples": [ - "\"********\"" + "octocat/Hello-World" ] }, - "insecure_ssl": { - "oneOf": [ - { + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { "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.**", "examples": [ - "\"0\"" + "octocat" ] }, - { - "type": "number" + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] - } - } - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-09-06T20:39:23Z" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-09-06T17:26:27Z" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks/1" - ] - }, - "test_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks/1/test" - ] - }, - "ping_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks/1/pings" - ] - }, - "deliveries_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries" - ] - }, - "last_response": { - "title": "Hook Response", - "type": "object", - "properties": { - "code": { + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { "type": [ - "integer", + "string", "null" + ], + "examples": [ + "This your first repo!" ] }, - "status": { + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { "type": [ "string", "null" ] }, - "message": { + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { "type": [ "string", "null" ] - } - }, - "required": [ - "code", - "status", - "message" - ] - } - }, - "required": [ - "id", - "url", - "type", - "name", - "active", - "events", - "config", - "ping_url", - "created_at", - "updated_at", - "last_response", - "test_url" - ] - }, - "examples": { - "default": { - "value": { - "type": "Repository", - "id": 12345678, - "name": "web", - "active": true, - "events": [ - "push", - "pull_request" - ], - "config": { - "content_type": "json", - "insecure_ssl": "0", - "url": "https://example.com/webhook" - }, - "updated_at": "2019-06-03T00:57:16Z", - "created_at": "2019-06-03T00:57:16Z", - "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", - "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test", - "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings", - "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", - "last_response": { - "code": null, - "status": "unused", - "message": null - } - } - } - } - } - }, - "headers": { - "Location": { - "example": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", - "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" - } - } - } - } - } - }, - "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": { + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "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" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "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" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "webhooks" - } - } - }, - "/repos/{owner}/{repo}/hooks/{hook_id}": { - "get": { - "summary": "Get a repository webhook", - "description": "Returns a webhook configured in a repository. To get only the webhook `config` properties, see \"[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository).\"", - "tags": [ - "repos" - ], - "operationId": "repos/get-webhook", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook" - }, - "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": "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", - "description": "Webhooks for repositories.", - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "id": { - "description": "Unique identifier of the webhook.", - "type": "integer", - "examples": [ - 42 - ] - }, - "name": { - "description": "The name of a valid service, use 'web' for a webhook.", - "type": "string", - "examples": [ - "web" - ] - }, - "active": { - "description": "Determines whether the hook is actually triggered on pushes.", - "type": "boolean", - "examples": [ - true - ] - }, - "events": { - "description": "Determines what events the hook is triggered for. Default: ['push'].", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "push", - "pull_request" - ] - }, - "config": { - "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.", - "format": "uri", + }, + "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", + "null" + ], + "format": "date-time", "examples": [ - "https://example.com/webhook" + "2011-01-26T19:06:43Z" ] }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", "examples": [ - "\"json\"" + "2011-01-26T19:01:12Z" ] }, - "secret": { + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { "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).", "examples": [ - "\"********\"" + "admin" ] }, - "insecure_ssl": { - "oneOf": [ - { + "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", - "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.**", "examples": [ - "\"0\"" + "contributor_covenant" ] }, - { - "type": "number" + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# 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", + "null" + ], + "format": "uri" } + }, + "required": [ + "url", + "html_url", + "key", + "name" ] - } - } - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-09-06T20:39:23Z" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-09-06T17:26:27Z" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks/1" - ] - }, - "test_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks/1/test" - ] - }, - "ping_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks/1/pings" - ] - }, - "deliveries_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries" - ] - }, - "last_response": { - "title": "Hook Response", - "type": "object", - "properties": { - "code": { + }, + "license": { "type": [ - "integer", + "object", "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 ] }, - "status": { - "type": [ - "string", - "null" + "open_issues": { + "type": "integer", + "examples": [ + 0 ] }, - "message": { + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { "type": [ - "string", + "object", "null" - ] - } - }, - "required": [ - "code", - "status", - "message" - ] - } - }, - "required": [ - "id", - "url", - "type", - "name", - "active", - "events", - "config", - "ping_url", - "created_at", - "updated_at", - "last_response", - "test_url" - ] - }, - "examples": { - "default": { - "value": { - "type": "Repository", - "id": 12345678, - "name": "web", - "active": true, - "events": [ - "push", - "pull_request" - ], - "config": { - "content_type": "json", - "insecure_ssl": "0", - "url": "https://example.com/webhook" - }, - "updated_at": "2019-06-03T00:57:16Z", - "created_at": "2019-06-03T00:57:16Z", - "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", - "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test", - "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings", - "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", - "last_response": { - "code": null, - "status": "unused", - "message": 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" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "webhooks" - } - }, - "patch": { - "summary": "Update a repository webhook", - "description": "Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use \"[Update a webhook configuration for a repository](/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository).\"", - "tags": [ - "repos" - ], - "operationId": "repos/update-webhook", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook" - }, - "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": "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, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "config": { - "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.", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"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).", - "examples": [ - "\"********\"" - ] - }, - "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.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ] - } - } - }, - "events": { - "type": "array", - "description": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events.", - "default": [ - "push" - ], - "items": { - "type": "string" - } - }, - "add_events": { - "type": "array", - "description": "Determines a list of events to be added to the list of events that the Hook triggers for.", - "items": { - "type": "string" - } - }, - "remove_events": { - "type": "array", - "description": "Determines a list of events to be removed from the list of events that the Hook triggers for.", - "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 - } - } - }, - "examples": { - "default": { - "value": { - "active": true, - "add_events": [ - "pull_request" - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Webhook", - "description": "Webhooks for repositories.", - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "id": { - "description": "Unique identifier of the webhook.", - "type": "integer", - "examples": [ - 42 - ] - }, - "name": { - "description": "The name of a valid service, use 'web' for a webhook.", - "type": "string", - "examples": [ - "web" - ] - }, - "active": { - "description": "Determines whether the hook is actually triggered on pushes.", - "type": "boolean", - "examples": [ - true - ] - }, - "events": { - "description": "Determines what events the hook is triggered for. Default: ['push'].", - "type": "array", - "items": { - "type": "string" + ], + "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 + } }, - "examples": [ - "push", - "pull_request" + "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" ] }, - "config": { - "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.", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"json\"" - ] + "invitee": { + "anyOf": [ + { + "type": "null" }, - "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).", - "examples": [ - "\"********\"" + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] + } + ] + }, + "inviter": { + "anyOf": [ + { + "type": "null" }, - "insecure_ssl": { - "oneOf": [ - { + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { "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.**", "examples": [ - "\"0\"" + "octocat" ] }, - { - "type": "number" + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] } - } + ] }, - "updated_at": { + "permissions": { + "description": "The permission associated with the invitation.", "type": "string", - "format": "date-time", + "enum": [ + "read", + "write", + "admin", + "triage", + "maintain" + ], "examples": [ - "2011-09-06T20:39:23Z" + "read" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2011-09-06T17:26:27Z" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks/1" + "2016-06-13T14:52:50-05:00" ] }, - "test_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks/1/test" - ] + "expired": { + "description": "Whether or not the invitation has expired", + "type": "boolean" }, - "ping_url": { + "url": { + "description": "URL for the repository invitation", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks/1/pings" + "https://api.github.com/user/repository-invitations/1" ] }, - "deliveries_url": { + "html_url": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries" + "https://github.com/octocat/Hello-World/invitations" ] }, - "last_response": { - "title": "Hook Response", - "type": "object", - "properties": { - "code": { - "type": [ - "integer", - "null" - ] - }, - "status": { - "type": [ - "string", - "null" - ] - }, - "message": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "code", - "status", - "message" - ] + "node_id": { + "type": "string" } }, "required": [ "id", + "node_id", + "permissions", + "inviter", + "invitee", + "repository", "url", - "type", - "name", - "active", - "events", - "config", - "ping_url", - "created_at", - "updated_at", - "last_response", - "test_url" + "html_url", + "created_at" ] }, "examples": { "default": { "value": { - "type": "Repository", - "id": 12345678, - "name": "web", - "active": true, - "events": [ - "push", - "pull_request" - ], - "config": { - "content_type": "json", - "insecure_ssl": "0", - "url": "https://example.com/webhook" + "id": 1, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "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" }, - "updated_at": "2019-06-03T00:57:16Z", - "created_at": "2019-06-03T00:57:16Z", - "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", - "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test", - "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings", - "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", - "last_response": { - "code": null, - "status": "unused", - "message": null - } - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "invitee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "inviter": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "permissions": "write", + "created_at": "2016-06-13T14:52:50-05:00", + "expired": false, + "url": "https://api.github.com/user/repository_invitations/1296269", + "html_url": "https://github.com/octocat/Hello-World/invitations" } } } @@ -334376,20 +347036,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "webhooks" + "category": "collaborators", + "subcategory": "invitations" } }, "delete": { - "summary": "Delete a repository webhook", - "description": "Delete a webhook for an organization.\n\nThe authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook.", + "summary": "Delete a repository invitation", + "description": "", "tags": [ "repos" ], - "operationId": "repos/delete-webhook", + "operationId": "repos/delete-invitation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook" + "url": "https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation" }, "parameters": [ { @@ -334411,8 +347071,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.", + "name": "invitation_id", + "description": "The unique identifier of the invitation.", "in": "path", "required": true, "schema": { @@ -334423,53 +347083,27 @@ "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": "repos", - "subcategory": "webhooks" + "category": "collaborators", + "subcategory": "invitations" } } }, - "/repos/{owner}/{repo}/hooks/{hook_id}/config": { + "/repos/{owner}/{repo}/issues": { "get": { - "summary": "Get a webhook configuration for a repository", - "description": "Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use \"[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint.", + "summary": "List repository issues", + "description": "List issues in a repository. Only open issues will be listed.\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": [ - "repos" + "issues" ], - "operationId": "repos/get-webhook-config-for-repo", + "operationId": "issues/list-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository" + "url": "https://docs.github.com/rest/issues/issues#list-repository-issues" }, "parameters": [ { @@ -334491,290 +347125,111 @@ } }, { - "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": "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 are accepted. If the string `none` is passed, issues without milestones are returned.", + "in": "query", + "required": false, "schema": { - "type": "integer" + "type": "string" } - } - ], - "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.", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"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).", - "examples": [ - "\"********\"" - ] - }, - "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.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ] - } - } - }, - "examples": { - "default": { - "value": { - "content_type": "json", - "insecure_ssl": "0", - "secret": "********", - "url": "https://example.com/webhook" - } - } - } - } + }, + { + "name": "state", + "description": "Indicates the state of the issues to return.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "open", + "closed", + "all" + ], + "default": "open" } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "webhooks" - } - }, - "patch": { - "summary": "Update a webhook configuration for a repository", - "description": "Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use \"[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint.", - "tags": [ - "repos" - ], - "operationId": "repos/update-webhook-config-for-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository" - }, - "parameters": [ + }, { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, + "name": "assignee", + "description": "Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user.", + "in": "query", + "required": false, "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, + "name": "type", + "description": "Can be the name of an issue type. If the string `*` is passed, issues with any type are accepted. If the string `none` is passed, issues without type are returned.", + "in": "query", + "required": false, "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, + "name": "creator", + "description": "The user that created the issue.", + "in": "query", + "required": false, "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": false, - "properties": { - "url": { - "type": "string", - "description": "The URL to which the payloads will be delivered.", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"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).", - "examples": [ - "\"********\"" - ] - }, - "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.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ] - } - } - }, - "examples": { - "default": { - "summary": "Example of updating content type and URL", - "value": { - "content_type": "json", - "url": "https://example.com/webhook" - } - } - } - } - } - }, - "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.", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"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).", - "examples": [ - "\"********\"" - ] - }, - "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.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ] - } - } - }, - "examples": { - "default": { - "value": { - "content_type": "json", - "insecure_ssl": "0", - "secret": "********", - "url": "https://example.com/webhook" - } - } - } - } + "type": "string" } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "webhooks" - } - } - }, - "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries": { - "get": { - "summary": "List deliveries for a repository webhook", - "description": "Returns a list of webhook deliveries for a webhook configured in a repository.", - "tags": [ - "repos" - ], - "operationId": "repos/list-webhook-deliveries", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook" - }, - "parameters": [ + }, { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, + "name": "mentioned", + "description": "A user that's mentioned in the issue.", + "in": "query", + "required": false, "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, + "name": "labels", + "description": "A list of comma separated label names. Example: `bug,ui,@high`", + "in": "query", + "required": false, "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, + "name": "sort", + "description": "What to sort results by.", + "in": "query", + "required": false, "schema": { - "type": "integer" + "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" } }, { @@ -334787,12 +347242,12 @@ } }, { - "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.", + "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 } } ], @@ -334804,2294 +347259,2805 @@ "schema": { "type": "array", "items": { - "title": "Simple webhook delivery", - "description": "Delivery made by a webhook, without request and response information.", + "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 webhook delivery.", "type": "integer", - "format": "int64", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/1" + ] + }, + "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", + "type": "integer", "examples": [ 42 ] }, - "guid": { - "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", + "state": { + "description": "State of the issue; either 'open' or 'closed'", "type": "string", "examples": [ - "58474f00-b361-11eb-836d-0e4f3503ccbe" + "open" ] }, - "delivered_at": { - "description": "Time when the webhook delivery occurred.", + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate", + null + ], + "examples": [ + "not_planned" + ] + }, + "title": { + "description": "Title of the issue", "type": "string", - "format": "date-time", "examples": [ - "2021-05-12T20:33:44Z" + "Widget creation fails in Safari on OS X 10.8" ] }, - "redelivery": { - "description": "Whether the webhook delivery is a redelivery.", - "type": "boolean", + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ], "examples": [ - false + "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?" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "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", + "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", + "null" + ] + }, + "color": { + "type": [ + "string", + "null" + ] + }, + "default": { + "type": "boolean" + } + } + } + ] + }, + "examples": [ + "bug", + "registration" + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "assignees": { + "type": [ + "array", + "null" + ], + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string", + "examples": [ + "v1.0" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] + } + }, + "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" + ] + } ] }, - "duration": { - "description": "Time spent delivering.", - "type": "number", - "examples": [ - 0.03 - ] + "locked": { + "type": "boolean" }, - "status": { - "description": "Describes the response returned after attempting the delivery.", - "type": "string", - "examples": [ - "failed to connect" + "active_lock_reason": { + "type": [ + "string", + "null" ] }, - "status_code": { - "description": "Status code received when delivery was made.", - "type": "integer", - "examples": [ - 502 - ] + "comments": { + "type": "integer" }, - "event": { - "description": "The event that triggered the delivery.", - "type": "string", - "examples": [ - "issues" + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" ] }, - "action": { - "description": "The type of activity for the event that triggered the delivery.", + "closed_at": { "type": [ "string", "null" ], - "examples": [ - "opened" - ] + "format": "date-time" }, - "installation_id": { - "description": "The id of the GitHub App installation associated with this event.", - "type": [ - "integer", - "null" - ], - "format": "int64", - "examples": [ - 123 - ] + "created_at": { + "type": "string", + "format": "date-time" }, - "repository_id": { - "description": "The id of the repository associated with this event.", - "type": [ - "integer", - "null" - ], - "format": "int64", - "examples": [ - 123 + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } ] }, - "throttled_at": { - "description": "Time when the webhook delivery was throttled.", + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", "type": [ - "string", + "object", "null" ], - "format": "date-time", - "examples": [ - "2021-05-12T20:33:44Z" + "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", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "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" ] - } - }, - "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", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "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": { + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", - "required": [ - "code" - ], "properties": { - "resource": { - "type": "string" + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] }, - "field": { - "type": "string" + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] }, - "message": { - "type": "string" + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] }, - "code": { - "type": "string" + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] }, - "index": { + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { "type": "integer" }, - "value": { - "oneOf": [ - { + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { "type": [ "string", "null" ] }, - { + "email": { "type": [ - "integer", + "string", "null" ] }, - { + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { "type": [ - "array", + "string", "null" ], - "items": { - "type": "string" - } + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "webhooks" - } - } - }, - "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}": { - "get": { - "summary": "Get a delivery for a repository webhook", - "description": "Returns a delivery for a webhook configured in a repository.", - "tags": [ - "repos" - ], - "operationId": "repos/get-webhook-delivery", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook" - }, - "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": "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": "Webhook delivery", - "description": "Delivery made by a webhook.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the delivery.", - "type": "integer", - "examples": [ - 42 - ] - }, - "guid": { - "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", - "type": "string", - "examples": [ - "58474f00-b361-11eb-836d-0e4f3503ccbe" - ] - }, - "delivered_at": { - "description": "Time when the delivery was delivered.", - "type": "string", - "format": "date-time", - "examples": [ - "2021-05-12T20:33:44Z" - ] - }, - "redelivery": { - "description": "Whether the delivery is a redelivery.", - "type": "boolean", - "examples": [ - false - ] - }, - "duration": { - "description": "Time spent delivering.", - "type": "number", - "examples": [ - 0.03 - ] - }, - "status": { - "description": "Description of the status of the attempted delivery", - "type": "string", - "examples": [ - "failed to connect" - ] - }, - "status_code": { - "description": "Status code received when delivery was made.", - "type": "integer", - "examples": [ - 502 - ] - }, - "event": { - "description": "The event that triggered the delivery.", - "type": "string", - "examples": [ - "issues" - ] - }, - "action": { - "description": "The type of activity for the event that triggered the delivery.", - "type": [ - "string", - "null" - ], - "examples": [ - "opened" - ] - }, - "installation_id": { - "description": "The id of the GitHub App installation associated with this event.", - "type": [ - "integer", - "null" - ], - "examples": [ - 123 - ] - }, - "repository_id": { - "description": "The id of the repository associated with this event.", - "type": [ - "integer", - "null" - ], - "examples": [ - 123 - ] - }, - "throttled_at": { - "description": "Time when the webhook delivery was throttled.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2021-05-12T20:33:44Z" - ] - }, - "url": { - "description": "The URL target of the delivery.", - "type": "string", - "examples": [ - "https://www.example.com" - ] - }, - "request": { - "type": "object", - "properties": { - "headers": { - "description": "The request headers sent with the webhook delivery.", - "type": [ - "object", - "null" - ], - "additionalProperties": true - }, - "payload": { - "description": "The webhook payload.", - "type": [ - "object", - "null" - ], - "additionalProperties": true - } - }, - "required": [ - "headers", - "payload" - ] - }, - "response": { - "type": "object", - "properties": { - "headers": { - "description": "The response headers received when the delivery was made.", - "type": [ - "object", - "null" - ], - "additionalProperties": true - }, - "payload": { - "description": "The response payload received.", - "type": [ - "string", - "null" - ], - "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", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "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" + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" }, - "field": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] }, - "message": { + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", "type": "string" }, - "code": { + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { "type": "string" }, - "index": { + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { "type": "integer" }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "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" + ] + } ] }, - { - "type": [ - "integer", - "null" + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" ] }, - { + "description": { "type": [ - "array", + "string", "null" ], - "items": { + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" ] } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "webhooks" - } - } - }, - "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { - "post": { - "summary": "Redeliver a delivery for a repository webhook", - "description": "Redeliver a webhook delivery for a webhook configured in a repository.", - "tags": [ - "repos" - ], - "operationId": "repos/redeliver-webhook-delivery", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook" - }, - "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": "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": { - "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", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "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" + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" ], + "examples": [ + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", "properties": { - "resource": { - "type": "string" + "url": { + "type": "string", + "format": "uri" }, - "field": { - "type": "string" + "total_count": { + "type": "integer" }, - "message": { - "type": "string" + "+1": { + "type": "integer" }, - "code": { - "type": "string" + "-1": { + "type": "integer" }, - "index": { + "laugh": { "type": "integer" }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "webhooks" - } - } - }, - "/repos/{owner}/{repo}/hooks/{hook_id}/pings": { - "post": { - "summary": "Ping a repository webhook", - "description": "This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook.", - "tags": [ - "repos" - ], - "operationId": "repos/ping-webhook", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook" - }, - "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": "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", - "content": { - "application/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": "repos", - "subcategory": "webhooks" - } - } - }, - "/repos/{owner}/{repo}/hooks/{hook_id}/tests": { - "post": { - "summary": "Test the push repository webhook", - "description": "This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated.\n\n> [!NOTE]\n> Previously `/repos/:owner/:repo/hooks/:hook_id/test`", - "tags": [ - "repos" - ], - "operationId": "repos/test-push-webhook", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook" - }, - "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": "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", - "content": { - "application/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": "repos", - "subcategory": "webhooks" - } - } - }, - "/repos/{owner}/{repo}/import": { - "get": { - "summary": "Get an import status", - "description": "View the progress of an import.\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).\n\n**Import status**\n\nThis section includes details about the possible values of the `status` field of the Import Progress response.\n\nAn import that does not have errors will progress through these steps:\n\n* `detecting` - the \"detection\" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL.\n* `importing` - the \"raw\" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import).\n* `mapping` - the \"rewrite\" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.\n* `pushing` - the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is \"Writing objects\".\n* `complete` - the import is complete, and the repository is ready on GitHub.\n\nIf there are problems, you will see one of these in the `status` field:\n\n* `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.\n* `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information.\n* `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.\n* `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/rest/migrations/source-imports#start-an-import) with the correct URL.\n* `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.\n\n**The project_choices field**\n\nWhen multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.\n\n**Git LFS related fields**\n\nThis section includes details about Git LFS related fields that may be present in the Import Progress response.\n\n* `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken.\n* `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step.\n* `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository.\n* `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a \"Get Large Files\" request.", - "tags": [ - "migrations" - ], - "operationId": "migrations/get-import-status", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/migrations/source-imports#get-an-import-status" - }, - "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": { - "title": "Import", - "description": "A repository import from an external source.", - "type": "object", - "properties": { - "vcs": { - "type": [ - "string", - "null" - ] - }, - "use_lfs": { - "type": "boolean" - }, - "vcs_url": { - "description": "The URL of the originating repository.", - "type": "string" - }, - "svc_root": { - "type": "string" - }, - "tfvc_project": { - "type": "string" - }, - "status": { - "type": "string", - "enum": [ - "auth", - "error", - "none", - "detecting", - "choose", - "auth_failed", - "importing", - "mapping", - "waiting_to_push", - "pushing", - "complete", - "setup", - "unknown", - "detection_found_multiple", - "detection_found_nothing", - "detection_needs_auth" - ] - }, - "status_text": { - "type": [ - "string", - "null" - ] - }, - "failed_step": { - "type": [ - "string", - "null" - ] - }, - "error_message": { - "type": [ - "string", - "null" - ] - }, - "import_percent": { - "type": [ - "integer", - "null" - ] - }, - "commit_count": { - "type": [ - "integer", - "null" - ] - }, - "push_percent": { - "type": [ - "integer", - "null" - ] - }, - "has_large_files": { - "type": "boolean" - }, - "large_files_size": { - "type": "integer" - }, - "large_files_count": { - "type": "integer" - }, - "project_choices": { - "type": "array", - "items": { - "type": "object", - "properties": { - "vcs": { - "type": "string" + "confused": { + "type": "integer" }, - "tfvc_project": { - "type": "string" + "heart": { + "type": "integer" }, - "human_name": { - "type": "string" - } - } - } - }, - "message": { - "type": "string" - }, - "authors_count": { - "type": [ - "integer", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "authors_url": { - "type": "string", - "format": "uri" - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "svn_root": { - "type": "string" - } - }, - "required": [ - "vcs", - "vcs_url", - "status", - "url", - "repository_url", - "html_url", - "authors_url" - ] - }, - "examples": { - "default": { - "value": { - "vcs": "subversion", - "use_lfs": true, - "vcs_url": "http://svn.mycompany.com/svn/myproject", - "status": "complete", - "status_text": "Done", - "has_large_files": true, - "large_files_size": 132331036, - "large_files_count": 1, - "authors_count": 4, - "url": "https://api.github.com/repos/octocat/socm/import", - "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" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/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": "Unavailable due to service under maintenance.", - "content": { - "application/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": "migrations", - "subcategory": "source-imports", - "deprecationDate": "2023-10-12", - "removalDate": "2024-04-12" - }, - "deprecated": true - }, - "put": { - "summary": "Start an import", - "description": "Start a source import to a GitHub repository using GitHub Importer.\nImporting into a GitHub repository with GitHub Actions enabled is not supported and will\nreturn a status `422 Unprocessable Entity` response.\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", - "tags": [ - "migrations" - ], - "operationId": "migrations/start-import", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/migrations/source-imports#start-an-import" - }, - "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": { - "vcs_url": { - "type": "string", - "description": "The URL of the originating repository." - }, - "vcs": { - "type": "string", - "description": "The originating VCS type. Without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response.", - "enum": [ - "subversion", - "git", - "mercurial", - "tfvc" - ] - }, - "vcs_username": { - "type": "string", - "description": "If authentication is required, the username to provide to `vcs_url`." - }, - "vcs_password": { - "type": "string", - "description": "If authentication is required, the password to provide to `vcs_url`." - }, - "tfvc_project": { - "type": "string", - "description": "For a tfvc import, the name of the project that is being imported." - } - }, - "required": [ - "vcs_url" - ] - }, - "examples": { - "default": { - "value": { - "vcs": "subversion", - "vcs_url": "http://svn.mycompany.com/svn/myproject", - "vcs_username": "octocat", - "vcs_password": "secret" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Import", - "description": "A repository import from an external source.", - "type": "object", - "properties": { - "vcs": { - "type": [ - "string", - "null" - ] - }, - "use_lfs": { - "type": "boolean" - }, - "vcs_url": { - "description": "The URL of the originating repository.", - "type": "string" - }, - "svc_root": { - "type": "string" - }, - "tfvc_project": { - "type": "string" - }, - "status": { - "type": "string", - "enum": [ - "auth", - "error", - "none", - "detecting", - "choose", - "auth_failed", - "importing", - "mapping", - "waiting_to_push", - "pushing", - "complete", - "setup", - "unknown", - "detection_found_multiple", - "detection_found_nothing", - "detection_needs_auth" - ] - }, - "status_text": { - "type": [ - "string", - "null" - ] - }, - "failed_step": { - "type": [ - "string", - "null" - ] - }, - "error_message": { - "type": [ - "string", - "null" - ] - }, - "import_percent": { - "type": [ - "integer", - "null" - ] - }, - "commit_count": { - "type": [ - "integer", - "null" - ] - }, - "push_percent": { - "type": [ - "integer", - "null" - ] - }, - "has_large_files": { - "type": "boolean" - }, - "large_files_size": { - "type": "integer" - }, - "large_files_count": { - "type": "integer" - }, - "project_choices": { - "type": "array", - "items": { - "type": "object", - "properties": { - "vcs": { - "type": "string" + "hooray": { + "type": "integer" }, - "tfvc_project": { - "type": "string" + "eyes": { + "type": "integer" }, - "human_name": { - "type": "string" + "rocket": { + "type": "integer" } - } - } - }, - "message": { - "type": "string" - }, - "authors_count": { - "type": [ - "integer", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "authors_url": { - "type": "string", - "format": "uri" - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "svn_root": { - "type": "string" - } - }, - "required": [ - "vcs", - "vcs_url", - "status", - "url", - "repository_url", - "html_url", - "authors_url" - ] - }, - "examples": { - "default": { - "value": { - "vcs": "subversion", - "use_lfs": true, - "vcs_url": "http://svn.mycompany.com/svn/myproject", - "status": "importing", - "status_text": "Importing...", - "has_large_files": false, - "large_files_size": 0, - "large_files_count": 0, - "authors_count": 0, - "commit_count": 1042, - "url": "https://api.github.com/repos/octocat/socm/import", - "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" - } - } - } - } - }, - "headers": { - "Location": { - "example": "https://api.github.com/repos/spraints/socm/import", - "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" - ], + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" + "total": { + "type": "integer" }, - "index": { + "completed": { "type": "integer" }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] + "percent_completed": { + "type": "integer" } - } - } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "503": { - "description": "Unavailable due to service under maintenance.", - "content": { - "application/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": "migrations", - "subcategory": "source-imports", - "deprecationDate": "2023-10-12", - "removalDate": "2024-04-12" - }, - "deprecated": true - }, - "patch": { - "summary": "Update an import", - "description": "An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API\nrequest. If no parameters are provided, the import will be restarted.\n\nSome servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will\nhave the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array.\nYou can select the project to import by providing one of the objects in the `project_choices` array in the update request.\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", - "tags": [ - "migrations" - ], - "operationId": "migrations/update-import", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/migrations/source-imports#update-an-import" - }, - "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": false, - "content": { - "application/json": { - "schema": { - "type": [ - "object", - "null" - ], - "properties": { - "vcs_username": { - "type": "string", - "description": "The username to provide to the originating repository." - }, - "vcs_password": { - "type": "string", - "description": "The password to provide to the originating repository." - }, - "vcs": { - "type": "string", - "description": "The type of version control system you are migrating from.", - "enum": [ - "subversion", - "tfvc", - "git", - "mercurial" - ], - "examples": [ - "\"git\"" - ] - }, - "tfvc_project": { - "type": "string", - "description": "For a tfvc import, the name of the project that is being imported.", - "examples": [ - "\"project1\"" - ] - } - } - }, - "examples": { - "example-1": { - "summary": "Update authentication for an import", - "value": { - "vcs_username": "octocat", - "vcs_password": "secret" - } - }, - "example-2": { - "summary": "Updating the project choice", - "value": { - "vcs": "tfvc", - "tfvc_project": "project1", - "human_name": "project1 (tfs)" - } - }, - "example-3": { - "summary": "Restarting an import" - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Import", - "description": "A repository import from an external source.", - "type": "object", - "properties": { - "vcs": { - "type": [ - "string", - "null" - ] - }, - "use_lfs": { - "type": "boolean" - }, - "vcs_url": { - "description": "The URL of the originating repository.", - "type": "string" - }, - "svc_root": { - "type": "string" - }, - "tfvc_project": { - "type": "string" - }, - "status": { - "type": "string", - "enum": [ - "auth", - "error", - "none", - "detecting", - "choose", - "auth_failed", - "importing", - "mapping", - "waiting_to_push", - "pushing", - "complete", - "setup", - "unknown", - "detection_found_multiple", - "detection_found_nothing", - "detection_needs_auth" - ] - }, - "status_text": { - "type": [ - "string", - "null" - ] - }, - "failed_step": { - "type": [ - "string", - "null" - ] - }, - "error_message": { - "type": [ - "string", - "null" - ] - }, - "import_percent": { - "type": [ - "integer", - "null" - ] - }, - "commit_count": { - "type": [ - "integer", - "null" - ] - }, - "push_percent": { - "type": [ - "integer", - "null" - ] - }, - "has_large_files": { - "type": "boolean" - }, - "large_files_size": { - "type": "integer" - }, - "large_files_count": { - "type": "integer" - }, - "project_choices": { - "type": "array", - "items": { + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", "type": "object", "properties": { - "vcs": { - "type": "string" + "blocked_by": { + "type": "integer" }, - "tfvc_project": { - "type": "string" + "blocking": { + "type": "integer" }, - "human_name": { - "type": "string" + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" } - } - } - }, - "message": { - "type": "string" - }, - "authors_count": { - "type": [ - "integer", - "null" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "authors_url": { - "type": "string", - "format": "uri" - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "svn_root": { - "type": "string" - } - }, - "required": [ - "vcs", - "vcs_url", - "status", - "url", - "repository_url", - "html_url", - "authors_url" - ] - }, - "examples": { - "example-1": { - "summary": "Example 1", - "value": { - "vcs": "subversion", - "use_lfs": true, - "vcs_url": "http://svn.mycompany.com/svn/myproject", - "status": "detecting", - "url": "https://api.github.com/repos/octocat/socm/import", - "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" - } - }, - "example-2": { - "summary": "Example 2", - "value": { - "vcs": "tfvc", - "use_lfs": true, - "vcs_url": "http://tfs.mycompany.com/tfs/myproject", - "tfvc_project": "project1", - "status": "importing", - "status_text": "Importing...", - "has_large_files": false, - "large_files_size": 0, - "large_files_count": 0, - "authors_count": 0, - "commit_count": 1042, - "url": "https://api.github.com/repos/octocat/socm/import", - "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" - } - }, - "example-3": { - "summary": "Response", - "value": { - "vcs": "subversion", - "use_lfs": true, - "vcs_url": "http://svn.mycompany.com/svn/myproject", - "status": "importing", - "status_text": "Importing...", - "has_large_files": false, - "large_files_size": 0, - "large_files_count": 0, - "authors_count": 0, - "commit_count": 1042, - "url": "https://api.github.com/repos/octocat/socm/import", - "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": { - "description": "Unavailable due to service under maintenance.", - "content": { - "application/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": "migrations", - "subcategory": "source-imports", - "deprecationDate": "2023-10-12", - "removalDate": "2024-04-12" - }, - "deprecated": true - }, - "delete": { - "summary": "Cancel an import", - "description": "Stop an import for a repository.\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", - "tags": [ - "migrations" - ], - "operationId": "migrations/cancel-import", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/migrations/source-imports#cancel-an-import" - }, - "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" - }, - "503": { - "description": "Unavailable due to service under maintenance.", - "content": { - "application/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": "migrations", - "subcategory": "source-imports", - "deprecationDate": "2023-10-12", - "removalDate": "2024-04-12" - }, - "deprecated": true - } - }, - "/repos/{owner}/{repo}/import/authors": { - "get": { - "summary": "Get commit authors", - "description": "Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `.\n\nThis endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information.\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", - "tags": [ - "migrations" - ], - "operationId": "migrations/get-commit-authors", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/migrations/source-imports#get-commit-authors" - }, - "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": "since", - "description": "A user ID. Only return users with an ID greater than this ID.", - "in": "query", - "required": false, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Porter Author", - "description": "Porter Author", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "remote_id": { - "type": "string" - }, - "remote_name": { - "type": "string" - }, - "email": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "import_url": { - "type": "string", - "format": "uri" + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", "id", - "remote_id", - "remote_name", - "email", - "name", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", "url", - "import_url" + "user", + "author_association", + "created_at", + "updated_at" ] } }, @@ -337099,66 +350065,179 @@ "default": { "value": [ { - "id": 2268557, - "remote_id": "nobody@fc7da526-431c-80fe-3c8c-c148ff18d7ef", - "remote_name": "nobody", - "email": "hubot@github.com", - "name": "Hubot", - "url": "https://api.github.com/repos/octocat/socm/import/authors/2268557", - "import_url": "https://api.github.com/repos/octocat/socm/import" - }, - { - "id": 2268558, - "remote_id": "svner@fc7da526-431c-80fe-3c8c-c148ff18d7ef", - "remote_name": "svner", - "email": "svner@fc7da526-431c-80fe-3c8c-c148ff18d7ef", - "name": "svner", - "url": "https://api.github.com/repos/octocat/socm/import/authors/2268558", - "import_url": "https://api.github.com/repos/octocat/socm/import" - }, - { - "id": 2268559, - "remote_id": "svner@example.com@fc7da526-431c-80fe-3c8c-c148ff18d7ef", - "remote_name": "svner@example.com", - "email": "svner@example.com@fc7da526-431c-80fe-3c8c-c148ff18d7ef", - "name": "svner@example.com", - "url": "https://api.github.com/repos/octocat/socm/import/authors/2268559", - "import_url": "https://api.github.com/repos/octocat/socm/import" + "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" } ] } } } - } - }, - "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" } } } }, - "503": { - "description": "Unavailable due to service under maintenance.", + "301": { + "description": "Moved permanently", "content": { "application/json": { "schema": { @@ -337182,147 +350261,6 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "migrations", - "subcategory": "source-imports", - "deprecationDate": "2023-10-12", - "removalDate": "2024-04-12" - }, - "deprecated": true - } - }, - "/repos/{owner}/{repo}/import/authors/{author_id}": { - "patch": { - "summary": "Map a commit author", - "description": "Update an author's identity for the import. Your application can continue updating authors any time before you push\nnew commits to the repository.\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", - "tags": [ - "migrations" - ], - "operationId": "migrations/map-commit-author", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/migrations/source-imports#map-a-commit-author" - }, - "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": "author_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "email": { - "type": "string", - "description": "The new Git author email." - }, - "name": { - "type": "string", - "description": "The new Git author name." - } - }, - "additionalProperties": false - }, - "examples": { - "default": { - "value": { - "email": "hubot@github.com", - "name": "Hubot the Robot" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Porter Author", - "description": "Porter Author", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "remote_id": { - "type": "string" - }, - "remote_name": { - "type": "string" - }, - "email": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "import_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "remote_id", - "remote_name", - "email", - "name", - "url", - "import_url" - ] - }, - "examples": { - "default": { - "value": { - "id": 2268557, - "remote_id": "nobody@fc7da526-431c-80fe-3c8c-c148ff18d7ef", - "remote_name": "nobody", - "email": "hubot@github.com", - "name": "Hubot", - "url": "https://api.github.com/repos/octocat/socm/import/authors/2268557", - "import_url": "https://api.github.com/repos/octocat/socm/import" - } - } - } - } - } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", @@ -337424,56 +350362,25 @@ } } } - }, - "503": { - "description": "Unavailable due to service under maintenance.", - "content": { - "application/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": "migrations", - "subcategory": "source-imports", - "deprecationDate": "2023-10-12", - "removalDate": "2024-04-12" - }, - "deprecated": true - } - }, - "/repos/{owner}/{repo}/import/large_files": { - "get": { - "summary": "Get large files", - "description": "List files larger than 100MB found during the import\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", + "category": "issues", + "subcategory": "issues" + } + }, + "post": { + "summary": "Create an issue", + "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\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).\"\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": [ - "migrations" + "issues" ], - "operationId": "migrations/get-large-files", + "operationId": "issues/create", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/migrations/source-imports#get-large-files" + "url": "https://docs.github.com/rest/issues/issues#create-an-issue" }, "parameters": [ { @@ -337495,160 +350402,119 @@ } } ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Porter Large File", - "description": "Porter Large File", - "type": "object", - "properties": { - "ref_name": { - "type": "string" - }, - "path": { - "type": "string" - }, - "oid": { + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "oneOf": [ + { "type": "string" }, - "size": { + { "type": "integer" } - }, - "required": [ - "oid", - "path", - "ref_name", - "size" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "ref_name": "refs/heads/master", - "path": "foo/bar/1", - "oid": "d3d9446802a44259755d38e6d163e820", - "size": 10485760 - }, + ], + "description": "The title of the issue." + }, + "body": { + "type": "string", + "description": "The contents of the issue." + }, + "assignee": { + "type": [ + "string", + "null" + ], + "description": "Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is closing down.**_" + }, + "milestone": { + "oneOf": [ { - "ref_name": "refs/heads/master", - "path": "foo/bar/2", - "oid": "6512bd43d9caa6e02c990b0a82652dca", - "size": 11534336 + "type": "string" }, { - "ref_name": "refs/heads/master", - "path": "foo/bar/3", - "oid": "c20ad4d76fe97759aa27a0c99bff6710", - "size": 12582912 + "type": "integer", + "description": "The `number` of the milestone to associate this issue with. _NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise._" } + ], + "type": [ + "null", + "string", + "integer" ] - } - } - } - } - }, - "503": { - "description": "Unavailable due to service under maintenance.", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { + }, + "labels": { + "type": "array", + "description": "Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "color": { + "type": [ + "string", + "null" + ] + } + } + } + ] + } + }, + "assignees": { + "type": "array", + "description": "Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", + "items": { "type": "string" } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "migrations", - "subcategory": "source-imports", - "deprecationDate": "2023-10-12", - "removalDate": "2024-04-12" - }, - "deprecated": true - } - }, - "/repos/{owner}/{repo}/import/lfs": { - "patch": { - "summary": "Update Git LFS preference", - "description": "You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability\nis powered by [Git LFS](https://git-lfs.com).\n\nYou can learn more about our LFS feature and working with large files [on our help\nsite](https://docs.github.com/repositories/working-with-files/managing-large-files).\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", - "tags": [ - "migrations" - ], - "operationId": "migrations/set-lfs-preference", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference" - }, - "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": { - "use_lfs": { - "type": "string", - "description": "Whether to store large files during the import. `opt_in` means large files will be stored using Git LFS. `opt_out` means large files will be removed during the import.", - "enum": [ - "opt_in", - "opt_out" + }, + "type": { + "type": [ + "string", + "null" + ], + "description": "The name of the issue type to associate with this issue. _NOTE: Only users with push access can set the type for new issues. The type is silently dropped otherwise._", + "examples": [ + "Epic" ] } }, "required": [ - "use_lfs" + "title" ] }, "examples": { "default": { "value": { - "use_lfs": "opt_in" + "title": "Found a bug", + "body": "I'm having a problem with this.", + "assignees": [ + "octocat" + ], + "milestone": 1, + "labels": [ + "bug" + ] } } } @@ -337656,342 +350522,326 @@ } }, "responses": { - "200": { + "201": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Import", - "description": "A repository import from an external source.", + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { - "vcs": { - "type": [ - "string", - "null" + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/1" ] }, - "use_lfs": { - "type": "boolean" + "repository_url": { + "type": "string", + "format": "uri" }, - "vcs_url": { - "description": "The URL of the originating repository.", + "labels_url": { "type": "string" }, - "svc_root": { - "type": "string" + "comments_url": { + "type": "string", + "format": "uri" }, - "tfvc_project": { - "type": "string" + "events_url": { + "type": "string", + "format": "uri" }, - "status": { + "html_url": { "type": "string", - "enum": [ - "auth", - "error", - "none", - "detecting", - "choose", - "auth_failed", - "importing", - "mapping", - "waiting_to_push", - "pushing", - "complete", - "setup", - "unknown", - "detection_found_multiple", - "detection_found_nothing", - "detection_needs_auth" - ] + "format": "uri" }, - "status_text": { - "type": [ - "string", - "null" + "number": { + "description": "Number uniquely identifying the issue within its repository", + "type": "integer", + "examples": [ + 42 ] }, - "failed_step": { - "type": [ - "string", - "null" + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" ] }, - "error_message": { + "state_reason": { + "description": "The reason for the current state", "type": [ "string", "null" + ], + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate", + null + ], + "examples": [ + "not_planned" ] }, - "import_percent": { - "type": [ - "integer", - "null" - ] - }, - "commit_count": { - "type": [ - "integer", - "null" + "title": { + "description": "Title of the issue", + "type": "string", + "examples": [ + "Widget creation fails in Safari on OS X 10.8" ] }, - "push_percent": { + "body": { + "description": "Contents of the issue", "type": [ - "integer", + "string", "null" + ], + "examples": [ + "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?" ] }, - "has_large_files": { - "type": "boolean" - }, - "large_files_size": { - "type": "integer" - }, - "large_files_count": { - "type": "integer" - }, - "project_choices": { - "type": "array", - "items": { - "type": "object", - "properties": { - "vcs": { - "type": "string" - }, - "tfvc_project": { - "type": "string" + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - "human_name": { - "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" + ] } - } - }, - "message": { - "type": "string" - }, - "authors_count": { - "type": [ - "integer", - "null" ] }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "authors_url": { - "type": "string", - "format": "uri" - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "svn_root": { - "type": "string" - } - }, - "required": [ - "vcs", - "vcs_url", - "status", - "url", - "repository_url", - "html_url", - "authors_url" - ] - }, - "examples": { - "default": { - "value": { - "vcs": "subversion", - "use_lfs": true, - "vcs_url": "http://svn.mycompany.com/svn/myproject", - "status": "complete", - "status_text": "Done", - "has_large_files": true, - "large_files_size": 132331036, - "large_files_count": 1, - "authors_count": 4, - "url": "https://api.github.com/repos/octocat/socm/import", - "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" - } - } - } - } - } - }, - "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": { + "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", "type": "array", "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { + "oneOf": [ + { "type": "string" }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { "type": [ "string", "null" ] }, - { + "color": { "type": [ - "integer", + "string", "null" ] }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } + "default": { + "type": "boolean" } - ] + } } - } - } - } - } - } - } - } - }, - "503": { - "description": "Unavailable due to service under maintenance.", - "content": { - "application/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": "migrations", - "subcategory": "source-imports", - "deprecationDate": "2023-10-12", - "removalDate": "2024-04-12" - }, - "deprecated": true - } - }, - "/repos/{owner}/{repo}/installation": { - "get": { - "summary": "Get a repository installation for the authenticated app", - "description": "Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.\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-repo-installation", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app" - }, - "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": { - "title": "Installation", - "description": "Installation", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", + ] + }, "examples": [ - 1 + "bug", + "registration" ] }, - "account": { + "assignee": { "anyOf": [ + { + "type": "null" + }, { "title": "Simple User", "description": "A GitHub user.", @@ -338159,595 +351009,581 @@ "type", "url" ] + } + ] + }, + "assignees": { + "type": [ + "array", + "null" + ], + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "milestone": { + "anyOf": [ { - "title": "Enterprise", - "description": "An enterprise on GitHub.", + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", "type": "object", "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/enterprises/octo-business" + "https://github.com/octocat/Hello-World/milestones/v1.0" ] }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] }, "id": { - "description": "Unique identifier of the enterprise", "type": "integer", "examples": [ - 42 + 1002604 ] }, "node_id": { "type": "string", "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "MDk6TWlsZXN0b25lMTAwMjYwNA==" ] }, - "name": { - "description": "The name of the enterprise.", + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", "examples": [ - "Octo Business" + "open" ] }, - "slug": { - "description": "The slug url identifier for the enterprise.", + "title": { + "description": "The title of the milestone.", "type": "string", "examples": [ - "octo-business" + "v1.0" ] }, - "created_at": { + "description": { "type": [ "string", "null" ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", "format": "date-time", "examples": [ - "2019-01-26T19:01:12Z" + "2011-04-10T20:09:31Z" ] }, "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { "type": [ "string", "null" ], "format": "date-time", "examples": [ - "2019-01-26T19:14:43Z" + "2013-02-12T13:22:01Z" ] }, - "avatar_url": { - "type": "string", - "format": "uri" + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] } }, "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" + "updated_at" ] } - ], - "type": [ - "null", - "object" - ] - }, - "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", - "examples": [ - "https://api.github.com/app/installations/1/access_tokens" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/installation/repositories" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/organizations/github/settings/installations/1" ] }, - "app_id": { - "type": "integer", - "examples": [ - 1 - ] + "locked": { + "type": "boolean" }, - "client_id": { - "type": "string", - "examples": [ - "Iv1.ab1112223334445c" + "active_lock_reason": { + "type": [ + "string", + "null" ] }, - "target_id": { - "description": "The ID of the user or organization this token is being scoped to.", + "comments": { "type": "integer" }, - "target_type": { - "type": "string", - "examples": [ - "Organization" - ] - }, - "permissions": { - "title": "App Permissions", + "pull_request": { "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" - ] + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - "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" - ] + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" }, - "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" - ] + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" }, - "profile": { - "type": "string", - "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", - "enum": [ - "write" - ] + "patch_url": { + "type": [ + "string", + "null" + ], + "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" - ] + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" } }, - "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", - "null" - ], - "examples": [ - "config.yaml" - ] - }, - "has_multiple_single_files": { - "type": "boolean", - "examples": [ - true - ] - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "config.yml", - ".github/issue_TEMPLATE.md" + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" ] }, - "app_slug": { + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "created_at": { "type": "string", - "examples": [ - "github-actions" - ] + "format": "date-time" }, - "suspended_by": { + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { "anyOf": [ { "type": "null" @@ -338922,2032 +351758,94 @@ } ] }, - "suspended_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "contact_email": { - "type": [ - "string", - "null" - ], - "examples": [ - "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"" - ] - } - }, - "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 - } - } - } - } - } - }, - "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": { + "body_html": { "type": "string" }, - "documentation_url": { + "body_text": { "type": "string" }, - "url": { - "type": "string" + "timeline_url": { + "type": "string", + "format": "uri" }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "apps", - "subcategory": "apps" - } - } - }, - "/repos/{owner}/{repo}/interaction-limits": { - "get": { - "summary": "Get interaction restrictions for a repository", - "description": "Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response.", - "tags": [ - "interactions" - ], - "operationId": "interactions/get-restrictions-for-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-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": { - "anyOf": [ - { - "title": "Interaction Limits", - "description": "Interaction limit settings.", - "type": "object", + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": [ + "object", + "null" + ], "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.", - "enum": [ - "existing_users", - "contributors_only", - "collaborators_only" - ], - "examples": [ - "collaborators_only" - ] + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." }, - "origin": { + "node_id": { "type": "string", - "examples": [ - "repository" - ] + "description": "The node identifier of the issue type." }, - "expires_at": { + "name": { "type": "string", - "format": "date-time", - "examples": [ - "2018-08-17T04:18:39Z" - ] - } - }, - "required": [ - "limit", - "origin", - "expires_at" - ] - }, - { - "type": "object", - "properties": {}, - "additionalProperties": false - } - ] - }, - "examples": { - "default": { - "value": { - "limit": "collaborators_only", - "origin": "repository", - "expires_at": "2018-08-17T04:18:39Z" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "interactions", - "subcategory": "repos" - } - }, - "put": { - "summary": "Set interaction restrictions for a repository", - "description": "Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository.", - "tags": [ - "interactions" - ], - "operationId": "interactions/set-restrictions-for-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-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": { - "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.", - "enum": [ - "existing_users", - "contributors_only", - "collaborators_only" - ], - "examples": [ - "collaborators_only" - ] - }, - "expiry": { - "type": "string", - "description": "The duration of the interaction restriction. Default: `one_day`.", - "enum": [ - "one_day", - "three_days", - "one_week", - "one_month", - "six_months" - ], - "examples": [ - "one_month" - ] - } - }, - "required": [ - "limit" - ] - }, - "examples": { - "default": { - "summary": "Example request body", - "value": { - "limit": "collaborators_only", - "expiry": "one_day" - } - } - } - } - } - }, - "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.", - "enum": [ - "existing_users", - "contributors_only", - "collaborators_only" - ], - "examples": [ - "collaborators_only" - ] - }, - "origin": { - "type": "string", - "examples": [ - "repository" - ] - }, - "expires_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2018-08-17T04:18:39Z" - ] - } - }, - "required": [ - "limit", - "origin", - "expires_at" - ] - }, - "examples": { - "default": { - "value": { - "limit": "collaborators_only", - "origin": "repository", - "expires_at": "2018-08-17T04:18:39Z" - } - } - } - } - } - }, - "409": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "interactions", - "subcategory": "repos" - } - }, - "delete": { - "summary": "Remove interaction restrictions for a repository", - "description": "Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository.", - "tags": [ - "interactions" - ], - "operationId": "interactions/remove-restrictions-for-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-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" - }, - "409": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "interactions", - "subcategory": "repos" - } - } - }, - "/repos/{owner}/{repo}/invitations": { - "get": { - "summary": "List repository invitations", - "description": "When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.", - "tags": [ - "repos" - ], - "operationId": "repos/list-invitations", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/collaborators/invitations#list-repository-invitations" - }, - "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": "Repository Invitation", - "description": "Repository invitations let you manage who you collaborate with.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository invitation.", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "repository": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "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", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "examples": [ - "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", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# 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", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "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" - ] - }, - "invitee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "inviter": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "permissions": { - "description": "The permission associated with the invitation.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "triage", - "maintain" - ], - "examples": [ - "read" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-06-13T14:52:50-05:00" - ] - }, - "expired": { - "description": "Whether or not the invitation has expired", - "type": "boolean" - }, - "url": { - "description": "URL for the repository invitation", - "type": "string", - "examples": [ - "https://api.github.com/user/repository-invitations/1" - ] - }, - "html_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World/invitations" - ] - }, - "node_id": { - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "permissions", - "inviter", - "invitee", - "repository", - "url", - "html_url", - "created_at" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 1, - "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" - }, - "invitee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "inviter": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "permissions": "write", - "created_at": "2016-06-13T14:52:50-05:00", - "url": "https://api.github.com/user/repository_invitations/1296269", - "html_url": "https://github.com/octocat/Hello-World/invitations", - "node_id": "MDQ6VXNlcjE=" - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "collaborators", - "subcategory": "invitations" - } - } - }, - "/repos/{owner}/{repo}/invitations/{invitation_id}": { - "patch": { - "summary": "Update a repository invitation", - "description": "", - "tags": [ - "repos" - ], - "operationId": "repos/update-invitation", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation" - }, - "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": "invitation_id", - "description": "The unique identifier of the invitation.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "permissions": { - "type": "string", - "description": "The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`.", - "enum": [ - "read", - "write", - "maintain", - "triage", - "admin" - ] - } - } - }, - "examples": { - "default": { - "summary": "Example request body", - "value": { - "permissions": "write" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Repository Invitation", - "description": "Repository invitations let you manage who you collaborate with.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository invitation.", - "type": "integer", - "format": "int64", - "examples": [ - 42 + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "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": "Minimal Repository", - "description": "Minimal Repository", + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", "properties": { "id": { + "description": "Unique identifier of the repository", "type": "integer", "format": "int64", "examples": [ - 1296269 + 42 ] }, "node_id": { @@ -340957,9 +351855,10 @@ ] }, "name": { + "description": "The name of the repository.", "type": "string", "examples": [ - "Hello-World" + "Team Environment" ] }, "full_name": { @@ -340968,6 +351867,96 @@ "octocat/Hello-World" ] }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, "owner": { "title": "Simple User", "description": "A GitHub user.", @@ -341137,6 +352126,8 @@ ] }, "private": { + "description": "Whether the repository is private or public.", + "default": false, "type": "boolean" }, "html_url": { @@ -341273,7 +352264,10 @@ ] }, "git_url": { - "type": "string" + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] }, "issue_comment_url": { "type": "string", @@ -341344,7 +352338,10 @@ ] }, "ssh_url": { - "type": "string" + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] }, "stargazers_url": { "type": "string", @@ -341394,12 +352391,19 @@ ] }, "clone_url": { - "type": "string" + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] }, "mirror_url": { "type": [ "string", "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" ] }, "hooks_url": { @@ -341410,12 +352414,20 @@ ] }, "svn_url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] }, "homepage": { "type": [ "string", "null" + ], + "format": "uri", + "examples": [ + "https://github.com" ] }, "language": { @@ -341425,26 +352437,50 @@ ] }, "forks_count": { - "type": "integer" + "type": "integer", + "examples": [ + 9 + ] }, "stargazers_count": { - "type": "integer" + "type": "integer", + "examples": [ + 80 + ] }, "watchers_count": { - "type": "integer" + "type": "integer", + "examples": [ + 80 + ] }, "size": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" + "type": "integer", + "examples": [ + 108 + ] }, "default_branch": { - "type": "string" + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] }, "open_issues_count": { - "type": "integer" + "type": "integer", + "examples": [ + 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", + "examples": [ + true + ] }, "topics": { "type": "array", @@ -341453,30 +352489,61 @@ } }, "has_issues": { - "type": "boolean" + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_projects": { - "type": "boolean" + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_wiki": { - "type": "boolean" + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] }, "has_pages": { "type": "boolean" }, "has_downloads": { - "type": "boolean" + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] }, "has_discussions": { - "type": "boolean" + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] }, "archived": { + "description": "Whether the repository is archived.", + "default": false, "type": "boolean" }, "disabled": { - "type": "boolean" + "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": { @@ -341509,238 +352576,136 @@ "2011-01-26T19:14:43Z" ] }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", "examples": [ - "admin" + true ] }, "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", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# 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", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true ] }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - } + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] }, - "forks": { - "type": "integer", + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", "examples": [ - 0 + false ] }, - "open_issues": { - "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", "examples": [ - 0 + false ] }, - "watchers": { - "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 + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", "examples": [ - 0 + true ] }, "allow_forking": { + "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { - "type": "boolean", + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", "examples": [ - false + "\"2020-07-09T00:17:42Z\"" ] }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], + "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": { - "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": [ @@ -341789,3020 +352754,1349 @@ "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" ] }, - "invitee": { + "performed_via_github_app": { "anyOf": [ { "type": "null" }, { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", + "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", + "null" + ], "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { + "description": "Unique identifier of the GitHub app", "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "inviter": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" + 37 ] }, - "login": { + "slug": { + "description": "The slug name of the GitHub app", "type": "string", "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 + "probot-owners" ] }, "node_id": { "type": "string", "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" + "MDExOkludGVncmF0aW9uMQ==" ] }, - "user_view_type": { + "client_id": { "type": "string", "examples": [ - "public" + "\"Iv1.25b5d1e65ffc4022\"" ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "permissions": { - "description": "The permission associated with the invitation.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "triage", - "maintain" - ], - "examples": [ - "read" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-06-13T14:52:50-05:00" - ] - }, - "expired": { - "description": "Whether or not the invitation has expired", - "type": "boolean" - }, - "url": { - "description": "URL for the repository invitation", - "type": "string", - "examples": [ - "https://api.github.com/user/repository-invitations/1" - ] - }, - "html_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World/invitations" - ] - }, - "node_id": { - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "permissions", - "inviter", - "invitee", - "repository", - "url", - "html_url", - "created_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "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" - }, - "invitee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "inviter": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "permissions": "write", - "created_at": "2016-06-13T14:52:50-05:00", - "expired": false, - "url": "https://api.github.com/user/repository_invitations/1296269", - "html_url": "https://github.com/octocat/Hello-World/invitations" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "collaborators", - "subcategory": "invitations" - } - }, - "delete": { - "summary": "Delete a repository invitation", - "description": "", - "tags": [ - "repos" - ], - "operationId": "repos/delete-invitation", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation" - }, - "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": "invitation_id", - "description": "The unique identifier of the invitation.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "collaborators", - "subcategory": "invitations" - } - } - }, - "/repos/{owner}/{repo}/issues": { - "get": { - "summary": "List repository issues", - "description": "List issues in a repository. Only open issues will be listed.\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-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/issues#list-repository-issues" - }, - "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": "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 are accepted. If the string `none` is passed, issues without milestones are returned.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "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": "assignee", - "description": "Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "type", - "description": "Can be the name of an issue type. If the string `*` is passed, issues with any type are accepted. If the string `none` is passed, issues without type are returned.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "creator", - "description": "The user that created the issue.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "mentioned", - "description": "A user that's mentioned in the issue.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "labels", - "description": "A list of comma separated label names. Example: `bug,ui,@high`", - "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", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/issues/1" - ] - }, - "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", - "type": "integer", - "examples": [ - 42 - ] - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ], - "examples": [ - "not_planned" - ] - }, - "title": { - "description": "Title of the issue", - "type": "string", - "examples": [ - "Widget creation fails in Safari on OS X 10.8" - ] - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ], - "examples": [ - "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?" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "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", - "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", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, - "default": { - "type": "boolean" - } - } - } - ] - }, - "examples": [ - "bug", - "registration" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "assignees": { - "type": [ - "array", - "null" - ], - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "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" + ] + } ] }, - "avatar_url": { + "name": { + "description": "The name of the GitHub app", "type": "string", - "format": "uri", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "Probot Owners" ] }, - "gravatar_id": { + "description": { "type": [ "string", "null" ], "examples": [ - "41d064eb2195891e12d0413f63227ea7" + "The description of the app." ] }, - "url": { + "external_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "https://example.com" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "https://github.com/apps/super-ci" ] }, - "received_events_url": { + "created_at": { "type": "string", - "format": "uri", + "format": "date-time", "examples": [ - "https://api.github.com/users/octocat/received_events" + "2017-07-08T16:18:44-04:00" ] }, - "type": { + "updated_at": { "type": "string", + "format": "date-time", "examples": [ - "User" + "2017-07-08T16:18:44-04:00" ] }, - "site_admin": { - "type": "boolean" + "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" + } }, - "starred_at": { - "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.", + "type": "array", + "items": { + "type": "string" + }, "examples": [ - "\"2020-07-09T00:17:55Z\"" + "label", + "deployment" ] }, - "user_view_type": { - "type": "string", + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", "examples": [ - "public" + 5 ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" ] } + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "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" + } }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/milestones/v1.0" - ] - }, - "labels_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDk6TWlsZXN0b25lMTAwMjYwNA==" - ] - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "examples": [ - 42 - ] - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open", - "examples": [ - "open" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string", - "examples": [ - "v1.0" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "Tracking milestone for version 1.0" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 4 - ] - }, - "closed_issues": { - "type": "integer", - "examples": [ - 8 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2013-02-12T13:22:01Z" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2012-10-09T23:39:01Z" - ] - } - }, - "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" - ] - } - ] - }, - "locked": { - "type": "boolean" - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "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" + } }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" + "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 }, - "created_at": { - "type": "string", - "format": "date-time" + "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 }, - "updated_at": { - "type": "string", - "format": "date-time" + "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" }, - "draft": { - "type": "boolean" + "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": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "body_html": { - "type": "string" + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false }, - "body_text": { + "author_association": "COLLABORATOR", + "state_reason": "completed" + } + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" - ], - "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", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "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", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] + } + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "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" }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" + "field": { + "type": "string" }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" + "message": { + "type": "string" }, - "open_issues": { - "type": "integer" + "code": { + "type": "string" }, - "watchers": { + "index": { "type": "integer" }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } ] + } + } + } + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "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": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issues" + } + } + }, + "/repos/{owner}/{repo}/issues/comments": { + "get": { + "summary": "List issue comments for a repository", + "description": "You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request.\n\nBy default, issue 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-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/comments#list-issue-comments-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": "sort", + "description": "The property to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated" + ], + "default": "created" + } + }, + { + "name": "direction", + "description": "Either `asc` or `desc`. Ignored without the `sort` parameter.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "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 Comment", + "description": "Comments provide a way for people to collaborate on an issue.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/comments/1" + ] + }, + "body": { + "description": "Contents of the issue comment", + "type": "string", + "examples": [ + "What version of Safari were you using when you observed this bug?" + ] + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { + "anyOf": [ + { + "type": "null" }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { + { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", - "description": "The status of the code search index for this repository", "properties": { - "lexical_search_ok": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { "type": "boolean" }, - "lexical_commit_sha": { - "type": "string" + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] } - }, - "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" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" ] }, "performed_via_github_app": { @@ -345213,24 +354507,6 @@ } ] }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "OWNER" - ] - }, "reactions": { "title": "Reaction Rollup", "type": "object", @@ -345279,48 +354555,16 @@ "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", + "html_url", + "issue_url", "author_association", + "user", + "url", "created_at", "updated_at" ] @@ -345331,17 +354575,10 @@ "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.", + "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, @@ -345362,130 +354599,10 @@ "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" + "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" } ] } @@ -345501,32 +354618,6 @@ } } }, - "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" - } - } - } - } - } - }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { @@ -345633,19 +354724,21 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "issues" + "subcategory": "comments" } - }, - "post": { - "summary": "Create an issue", - "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\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).\"\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`.", + } + }, + "/repos/{owner}/{repo}/issues/comments/{comment_id}": { + "get": { + "summary": "Get an issue comment", + "description": "You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\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", + "operationId": "issues/get-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/issues#create-an-issue" + "url": "https://docs.github.com/rest/issues/comments#get-an-issue-comment" }, "parameters": [ { @@ -345665,219 +354758,64 @@ "schema": { "type": "string" } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "title": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ], - "description": "The title of the issue." - }, - "body": { - "type": "string", - "description": "The contents of the issue." - }, - "assignee": { - "type": [ - "string", - "null" - ], - "description": "Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is closing down.**_" - }, - "milestone": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer", - "description": "The `number` of the milestone to associate this issue with. _NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise._" - } - ], - "type": [ - "null", - "string", - "integer" - ] - }, - "labels": { - "type": "array", - "description": "Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - } - } - } - ] - } - }, - "assignees": { - "type": "array", - "description": "Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", - "items": { - "type": "string" - } - }, - "type": { - "type": [ - "string", - "null" - ], - "description": "The name of the issue type to associate with this issue. _NOTE: Only users with push access can set the type for new issues. The type is silently dropped otherwise._", - "examples": [ - "Epic" - ] - } - }, - "required": [ - "title" - ] - }, - "examples": { - "default": { - "value": { - "title": "Found a bug", - "body": "I'm having a problem with this.", - "assignees": [ - "octocat" - ], - "milestone": 1, - "labels": [ - "bug" - ] - } - } - } + }, + { + "name": "comment_id", + "description": "The unique identifier of the comment.", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" } } - }, + ], "responses": { - "201": { + "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.", + "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", "type": "integer", - "format": "int64" + "format": "int64", + "examples": [ + 42 + ] }, "node_id": { "type": "string" }, "url": { - "description": "URL for the issue", + "description": "URL for the issue comment", "type": "string", "format": "uri", "examples": [ - "https://api.github.com/repositories/42/issues/1" + "https://api.github.com/repositories/42/issues/comments/1" ] }, - "repository_url": { + "body": { + "description": "Contents of the issue comment", "type": "string", - "format": "uri" + "examples": [ + "What version of Safari were you using when you observed this bug?" + ] }, - "labels_url": { + "body_text": { "type": "string" }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" + "body_html": { + "type": "string" }, "html_url": { "type": "string", "format": "uri" }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "type": "integer", - "examples": [ - 42 - ] - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ], - "examples": [ - "not_planned" - ] - }, - "title": { - "description": "Title of the issue", - "type": "string", - "examples": [ - "Widget creation fails in Safari on OS X 10.8" - ] - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ], - "examples": [ - "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?" - ] - }, "user": { "anyOf": [ { @@ -346053,56 +354991,698 @@ } ] }, - "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", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "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", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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" + } }, - "node_id": { + "additionalProperties": { "type": "string" }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { + "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.", + "type": "array", + "items": { "type": "string" }, - "description": { - "type": [ - "string", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] } - } - ] + }, + "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" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/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" + } + }, + "patch": { + "summary": "Update an issue comment", + "description": "You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\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-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/comments#update-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": { + "body": { + "type": "string", + "description": "The contents of the comment." + } + }, + "required": [ + "body" + ] + }, + "examples": { + "default": { + "value": { + "body": "Me too" + } + } + } + } + } + }, + "responses": { + "200": { + "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", + "type": "integer", + "format": "int64", "examples": [ - "bug", - "registration" + 42 ] }, - "assignee": { + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/comments/1" + ] + }, + "body": { + "description": "Contents of the issue comment", + "type": "string", + "examples": [ + "What version of Safari were you using when you observed this bug?" + ] + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { "anyOf": [ { "type": "null" @@ -346277,263 +355857,83 @@ } ] }, - "assignees": { - "type": [ - "array", - "null" + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" ], - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "examples": [ + "OWNER" + ] }, - "milestone": { + "performed_via_github_app": { "anyOf": [ { "type": "null" }, { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", + "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", + "null" + ], "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/milestones/v1.0" - ] - }, - "labels_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - ] - }, "id": { + "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDk6TWlsZXN0b25lMTAwMjYwNA==" - ] - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "examples": [ - 42 + 37 ] }, - "state": { - "description": "The state of the milestone.", + "slug": { + "description": "The slug name of the GitHub app", "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open", "examples": [ - "open" + "probot-owners" ] }, - "title": { - "description": "The title of the milestone.", + "node_id": { "type": "string", "examples": [ - "v1.0" + "MDExOkludGVncmF0aW9uMQ==" ] }, - "description": { - "type": [ - "string", - "null" - ], + "client_id": { + "type": "string", "examples": [ - "Tracking milestone for version 1.0" + "\"Iv1.25b5d1e65ffc4022\"" ] }, - "creator": { - "anyOf": [ - { - "type": "null" - }, + "owner": { + "oneOf": [ { "title": "Simple User", "description": "A GitHub user.", @@ -346701,154 +356101,932 @@ "type", "url" ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "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" + ] } ] }, - "open_issues": { - "type": "integer", + "name": { + "description": "The name of the GitHub app", + "type": "string", "examples": [ - 4 + "Probot Owners" ] }, - "closed_issues": { - "type": "integer", + "description": { + "type": [ + "string", + "null" + ], "examples": [ - 8 + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2011-04-10T20:09:31Z" + "2017-07-08T16:18:44-04:00" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2014-03-03T18:58:10Z" + "2017-07-08T16:18:44-04:00" ] }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", + "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.", + "type": "array", + "items": { + "type": "string" + }, "examples": [ - "2013-02-12T13:22:01Z" + "label", + "deployment" ] }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time", + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", "examples": [ - "2012-10-09T23:39:01Z" + 5 ] } }, "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", "id", "node_id", - "labels_url", + "owner", + "name", + "description", + "external_url", "html_url", - "number", - "open_issues", - "state", - "title", - "url", "created_at", - "updated_at" + "updated_at", + "permissions", + "events" ] } ] }, - "locked": { - "type": "boolean" - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { + "reactions": { + "title": "Reaction Rollup", "type": "object", "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], + "url": { + "type": "string", "format": "uri" }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" + "total_count": { + "type": "integer" }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" + "+1": { + "type": "integer" }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" } }, "required": [ - "diff_url", - "html_url", - "patch_url", - "url" + "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" }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" + "documentation_url": { + "type": "string" }, - "created_at": { - "type": "string", - "format": "date-time" + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDg6UmVhY3Rpb24x" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "content": { + "description": "The reaction to use", + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "examples": [ + "heart" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-05-20T20:09:31Z" + ] + } }, - "updated_at": { - "type": "string", - "format": "date-time" + "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" }, - "draft": { - "type": "boolean" + "documentation_url": { + "type": "string" }, - "closed_by": { + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDg6UmVhY3Rpb24x" + ] + }, + "user": { "anyOf": [ { "type": "null" @@ -347023,206 +357201,99 @@ } ] }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { + "content": { + "description": "The reaction to use", "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": [ - "object", - "null" + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" ], - "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", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "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." - } + "examples": [ + "heart" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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 }, - "required": [ - "id", - "node_id", - "name", - "description" + "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", + "examples": [ + 1 ] }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] + "node_id": { + "type": "string", + "examples": [ + "MDg6UmVhY3Rpb24x" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" }, - "owner": { + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -347389,708 +357460,1008 @@ "type", "url" ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { + } + ] + }, + "content": { + "description": "The reaction to use", + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "examples": [ + "heart" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" + } + } + } + } + } + } + } + } + }, + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOklzc3VlRXZlbnQx" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/events/1" + ] + }, + "actor": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - "lexical_commit_sha": { - "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" + ] } - } + ] }, - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "owner": { - "oneOf": [ - { + "event": { + "type": "string", + "examples": [ + "closed" + ] + }, + "commit_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "commit_url": { + "type": [ + "string", + "null" + ], + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "issue": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/1" + ] + }, + "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", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate", + null + ], + "examples": [ + "not_planned" + ] + }, + "title": { + "description": "Title of the issue", + "type": "string", + "examples": [ + "Widget creation fails in Safari on OS X 10.8" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ], + "examples": [ + "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?" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "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", + "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", + "null" + ] + }, + "color": { + "type": [ + "string", + "null" + ] + }, + "default": { + "type": "boolean" + } + } + } + ] + }, + "examples": [ + "bug", + "registration" + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "assignees": { + "type": [ + "array", + "null" + ], + "items": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -348237,899 +358608,2721 @@ ] } }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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" + ] + } + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string", + "examples": [ + "v1.0" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] + } + }, + "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" + ] + } + ] + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "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", + "null" + ], + "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", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "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", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] + "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": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "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", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } }, - "avatar_url": { - "type": "string", - "format": "uri" - } + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "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", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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" + "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" + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, - "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.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 - ] - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "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" - ] - }, - "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 + "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" + ] + } + ] }, - "author_association": "COLLABORATOR", - "state_reason": "completed" - } - } - } - } - }, - "headers": { - "Location": { - "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347", - "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", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "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" - } - } - } - } - } - }, - "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": { + "label": { + "title": "Issue Event Label", + "description": "Issue Event Label", "type": "object", - "required": [ - "code" - ], "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" + "name": { + "type": [ + "string", + "null" + ] }, - "message": { - "type": "string" + "color": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "name", + "color" + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" }, - "code": { - "type": "string" + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "assigner": { + "anyOf": [ + { + "type": "null" }, - "index": { - "type": "integer" + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "review_requester": { + "anyOf": [ + { + "type": "null" }, - "value": { - "oneOf": [ - { + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { "type": [ "string", "null" ] }, - { - "type": [ - "integer", - "null" + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" ] }, - { + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { "type": [ - "array", + "string", "null" ], - "items": { - "type": "string" - } + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] } - } - } - } - } - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "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": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "issues" - } - } - }, - "/repos/{owner}/{repo}/issues/comments": { - "get": { - "summary": "List issue comments for a repository", - "description": "You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request.\n\nBy default, issue 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-for-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/comments#list-issue-comments-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": "sort", - "description": "The property to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated" - ], - "default": "created" - } - }, - { - "name": "direction", - "description": "Either `asc` or `desc`. Ignored without the `sort` parameter.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "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 Comment", - "description": "Comments provide a way for people to collaborate on an issue.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the issue comment", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/issues/comments/1" ] }, - "body": { - "description": "Contents of the issue comment", - "type": "string", - "examples": [ - "What version of Safari were you using when you observed this bug?" - ] - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { + "requested_reviewer": { "anyOf": [ { "type": "null" @@ -349304,23 +361497,308 @@ } ] }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" + "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", + "null" + ] + }, + "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", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" ] }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" + "dismissed_review": { + "title": "Issue Event Dismissed Review", + "type": "object", + "properties": { + "state": { + "type": "string" + }, + "review_id": { + "type": "integer" + }, + "dismissal_message": { + "type": [ + "string", + "null" + ] + }, + "dismissal_commit_id": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "state", + "review_id", + "dismissal_message" ] }, - "issue_url": { - "type": "string", - "format": "uri" + "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", @@ -349340,6 +361818,12 @@ "OWNER" ] }, + "lock_reason": { + "type": [ + "string", + "null" + ] + }, "performed_via_github_app": { "anyOf": [ { @@ -349747,67 +362231,17 @@ ] } ] - }, - "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" + "actor", + "event", + "commit_id", + "commit_url", + "created_at" ] } }, @@ -349816,11 +362250,9 @@ "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": { + "node_id": "MDEwOklzc3VlRXZlbnQx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1", + "actor": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -349840,10 +362272,148 @@ "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", - "updated_at": "2011-04-14T16:00:49Z", - "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", - "author_association": "COLLABORATOR" + "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" + } } ] } @@ -349923,392 +362493,1369 @@ "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": "issues", - "subcategory": "comments" - } - } - }, - "/repos/{owner}/{repo}/issues/comments/{comment_id}": { - "get": { - "summary": "Get an issue comment", - "description": "You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\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-comment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/comments#get-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": { - "200": { - "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", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/issues/comments/1" - ] - }, - "body": { - "description": "Contents of the issue comment", - "type": "string", - "examples": [ - "What version of Safari were you using when you observed this bug?" - ] - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" + } + ] + } + } + } + } + } + } + } + } + } + }, + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOklzc3VlRXZlbnQx" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/issues/events/1" + ] + }, + "actor": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "event": { + "type": "string", + "examples": [ + "closed" + ] + }, + "commit_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "commit_url": { + "type": [ + "string", + "null" + ], + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "issue": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/1" + ] + }, + "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", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate", + null + ], + "examples": [ + "not_planned" + ] + }, + "title": { + "description": "Title of the issue", + "type": "string", + "examples": [ + "Widget creation fails in Safari on OS X 10.8" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ], + "examples": [ + "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?" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "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", + "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", + "null" + ] + }, + "color": { + "type": [ + "string", + "null" + ] + }, + "default": { + "type": "boolean" + } + } + } + ] + }, + "examples": [ + "bug", + "registration" + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "assignees": { + "type": [ + "array", + "null" + ], + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string", + "examples": [ + "v1.0" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] + } + }, + "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" + ] + } ] }, - "email": { + "locked": { + "type": "boolean" + }, + "active_lock_reason": { "type": [ "string", "null" ] }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "comments": { + "type": "integer" }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" ] }, - "gravatar_id": { + "closed_at": { "type": [ "string", "null" ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "format": "date-time" }, - "received_events_url": { + "created_at": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] + "format": "date-time" }, - "type": { + "updated_at": { "type": "string", - "examples": [ - "User" - ] + "format": "date-time" }, - "site_admin": { + "draft": { "type": "boolean" }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "OWNER" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "owner": { - "oneOf": [ + "closed_by": { + "anyOf": [ + { + "type": "null" + }, { "title": "Simple User", "description": "A GitHub user.", @@ -350476,454 +364023,1605 @@ "type", "url" ] + } + ] + }, + "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", + "null" + ], + "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", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", + "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", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { "type": "object", "properties": { - "description": { - "description": "A short description of the enterprise.", + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { "type": [ "string", "null" ] }, - "html_url": { + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/enterprises/octo-business" + "https://github.com/images/error/octocat_happy.gif" ] }, - "website_url": { - "description": "The enterprise's website URL.", + "gravatar_id": { "type": [ "string", "null" ], - "format": "uri" + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "null" + ], + "properties": { "id": { - "description": "Unique identifier of the enterprise", + "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [ - 42 + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" ] }, "node_id": { "type": "string", "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "MDExOkludGVncmF0aW9uMQ==" ] }, - "name": { - "description": "The name of the enterprise.", + "client_id": { "type": "string", "examples": [ - "Octo Business" + "\"Iv1.25b5d1e65ffc4022\"" ] }, - "slug": { - "description": "The slug url identifier for the enterprise.", + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "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", "type": "string", "examples": [ - "octo-business" + "Probot Owners" ] }, - "created_at": { + "description": { "type": [ "string", "null" ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", "format": "date-time", "examples": [ - "2019-01-26T19:01:12Z" + "2017-07-08T16:18:44-04:00" ] }, "updated_at": { - "type": [ - "string", - "null" - ], + "type": "string", "format": "date-time", "examples": [ - "2019-01-26T19:14:43Z" + "2017-07-08T16:18:44-04:00" ] }, - "avatar_url": { - "type": "string", - "format": "uri" + "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.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] } }, "required": [ "id", "node_id", + "owner", "name", - "slug", + "description", + "external_url", "html_url", "created_at", "updated_at", - "avatar_url" + "permissions", + "events" ] } ] }, - "name": { - "description": "The name of the GitHub app", + "author_association": { + "title": "author_association", "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" ], "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" + "OWNER" ] }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" + "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" ] }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" + "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" ] }, - "permissions": { - "description": "The set of permissions for the GitHub app", + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", "type": "object", "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" + "blocked_by": { + "type": "integer" }, - "metadata": { - "type": "string" + "blocking": { + "type": "integer" }, - "contents": { - "type": "string" + "total_blocked_by": { + "type": "integer" }, - "deployments": { - "type": "string" + "total_blocking": { + "type": "integer" } }, - "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.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" ] } }, "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", "id", "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", "created_at", - "updated_at", - "permissions", - "events" + "updated_at" ] } ] }, - "reactions": { - "title": "Reaction Rollup", + "label": { + "title": "Issue Event Label", + "description": "Issue Event Label", "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" + "name": { + "type": [ + "string", + "null" + ] }, - "rocket": { - "type": "integer" + "color": { + "type": [ + "string", + "null" + ] } }, "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" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/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" - } - }, - "patch": { - "summary": "Update an issue comment", - "description": "You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\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-comment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/comments#update-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": { - "body": { - "type": "string", - "description": "The contents of the comment." - } - }, - "required": [ - "body" - ] - }, - "examples": { - "default": { - "value": { - "body": "Me too" - } - } - } - } - } - }, - "responses": { - "200": { - "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", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/issues/comments/1" - ] - }, - "body": { - "description": "Contents of the issue comment", - "type": "string", - "examples": [ - "What version of Safari were you using when you observed this bug?" + "name", + "color" ] }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { + "assignee": { "anyOf": [ { "type": "null" @@ -351098,1176 +365796,182 @@ } ] }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "OWNER" - ] - }, - "performed_via_github_app": { + "assigner": { "anyOf": [ { "type": "null" }, { - "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", - "null" - ], + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, "id": { - "description": "Unique identifier of the GitHub app", "type": "integer", + "format": "int64", "examples": [ - 37 + 1 ] }, - "slug": { - "description": "The slug name of the GitHub app", + "node_id": { "type": "string", "examples": [ - "probot-owners" + "MDQ6VXNlcjE=" ] }, - "node_id": { + "avatar_url": { "type": "string", + "format": "uri", "examples": [ - "MDExOkludGVncmF0aW9uMQ==" + "https://github.com/images/error/octocat_happy.gif" ] }, - "client_id": { + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { "type": "string", + "format": "uri", "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" + "https://api.github.com/users/octocat" ] }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "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" - ] - } + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" ] }, - "name": { - "description": "The name of the GitHub app", + "followers_url": { "type": "string", + "format": "uri", "examples": [ - "Probot Owners" + "https://api.github.com/users/octocat/followers" ] }, - "description": { - "type": [ - "string", - "null" - ], + "following_url": { + "type": "string", "examples": [ - "The description of the app." + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "external_url": { + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { "type": "string", "format": "uri", "examples": [ - "https://example.com" + "https://api.github.com/users/octocat/subscriptions" ] }, - "html_url": { + "organizations_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/apps/super-ci" + "https://api.github.com/users/octocat/orgs" ] }, - "created_at": { + "repos_url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2017-07-08T16:18:44-04:00" + "https://api.github.com/users/octocat/repos" ] }, - "updated_at": { + "events_url": { "type": "string", - "format": "date-time", "examples": [ - "2017-07-08T16:18:44-04:00" + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "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" - } + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_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.", - "type": "array", - "items": { - "type": "string" - }, + "type": { + "type": "string", "examples": [ - "label", - "deployment" + "User" ] }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", "examples": [ - 5 + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", "id", "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] } ] }, - "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", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "examples": [ - "heart" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" - ] - }, - "user": { + "review_requester": { "anyOf": [ { "type": "null" @@ -352442,94 +366146,7 @@ } ] }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "examples": [ - "heart" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDg6UmVhY3Rpb24x" - ] - }, - "user": { + "requested_reviewer": { "anyOf": [ { "type": "null" @@ -352671,1038 +366288,408 @@ "starred_at": { "type": "string", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "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", + "null" + ] + }, + "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", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "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", + "null" + ] + }, + "dismissal_commit_id": { + "type": [ + "string", + "null" + ] + } + }, + "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", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + }, + "lock_reason": { + "type": [ + "string", + "null" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" ] }, - "user_view_type": { + "client_id": { "type": "string", "examples": [ - "public" + "\"Iv1.25b5d1e65ffc4022\"" ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "content": { - "description": "The reaction to use", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "examples": [ - "heart" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOklzc3VlRXZlbnQx" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/events/1" - ] - }, - "actor": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "event": { - "type": "string", - "examples": [ - "closed" - ] - }, - "commit_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "commit_url": { - "type": [ - "string", - "null" - ], - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] - }, - "issue": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/issues/1" - ] - }, - "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", - "type": "integer", - "examples": [ - 42 - ] - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ], - "examples": [ - "not_planned" - ] - }, - "title": { - "description": "Title of the issue", - "type": "string", - "examples": [ - "Widget creation fails in Safari on OS X 10.8" - ] - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ], - "examples": [ - "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?" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "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", - "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", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - }, - "examples": [ - "bug", - "registration" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "assignees": { - "type": [ - "array", - "null" - ], - "items": { + "owner": { + "oneOf": [ + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -353773,3891 +366760,3662 @@ "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/milestones/v1.0" - ] - }, - "labels_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDk6TWlsZXN0b25lMTAwMjYwNA==" - ] - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "examples": [ - 42 - ] - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open", - "examples": [ - "open" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string", - "examples": [ - "v1.0" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "Tracking milestone for version 1.0" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 4 - ] - }, - "closed_issues": { - "type": "integer", - "examples": [ - 8 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2013-02-12T13:22:01Z" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2012-10-09T23:39:01Z" - ] - } - }, - "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" - ] - } - ] - }, - "locked": { - "type": "boolean" - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "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", - "null" - ], - "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", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "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", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + ] }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } - } + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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": [ - "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": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "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", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 - ] - } + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "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" + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } }, - "rocket": { - "type": "integer" - } + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "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" - } + "checks": { + "type": "string" }, - "required": [ - "total", - "completed", - "percent_completed" - ] + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" } }, - "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" - ] - } - ] + "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.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "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 }, - "label": { - "title": "Issue Event Label", - "description": "Issue Event Label", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] + "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/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", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/1" + ] + }, + "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", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate", + null + ], + "examples": [ + "not_planned" + ] + }, + "title": { + "description": "Title of the issue", + "type": "string", + "examples": [ + "Widget creation fails in Safari on OS X 10.8" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ], + "examples": [ + "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?" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - "color": { - "type": [ - "string", - "null" - ] - } - }, - "required": [ - "name", - "color" - ] - }, - "assignee": { - "anyOf": [ + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "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", + "type": "array", + "items": { + "oneOf": [ { - "type": "null" + "type": "string" }, { - "title": "Simple User", - "description": "A GitHub user.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { "type": "integer", - "format": "int64", - "examples": [ - 1 - ] + "format": "int64" }, "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] + "type": "string" }, "url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "format": "uri" }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "assigner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { "name": { - "type": [ - "string", - "null" - ] + "type": "string" }, - "email": { + "description": { "type": [ "string", "null" ] }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { + "color": { "type": [ "string", "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" ] }, - "site_admin": { + "default": { "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + } } ] }, - "review_requester": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + "examples": [ + "bug", + "registration" + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "requested_reviewer": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + "email": { + "type": [ + "string", + "null" + ] }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "requested_team": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "assignees": { + "type": [ + "array", + "null" + ], + "items": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, "id": { - "type": "integer" + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] }, "node_id": { - "type": "string" - }, - "name": { - "type": "string" + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] }, - "slug": { - "type": "string" + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, - "description": { + "gravatar_id": { "type": [ "string", "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" ] }, - "privacy": { - "type": "string" + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] }, - "notification_setting": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] }, - "permission": { - "type": "string" + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] }, - "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" + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "url": { + "gists_url": { "type": "string", - "format": "uri" + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] }, - "html_url": { + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/orgs/rails/teams/core" + "https://api.github.com/users/octocat/subscriptions" ] }, - "members_url": { - "type": "string" + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] }, - "repositories_url": { + "repos_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] - } + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", "id", "node_id", - "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" ] + } + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string", + "examples": [ + "v1.0" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] + } + }, + "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" + ] + } + ] + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } }, - "dismissed_review": { - "title": "Issue Event Dismissed Review", - "type": "object", - "properties": { - "state": { - "type": "string" + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - "review_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" + ] + } + ] + }, + "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", + "null" + ], + "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", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "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", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } }, - "dismissal_message": { - "type": [ - "string", - "null" - ] + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - "dismissal_commit_id": { - "type": [ - "string", - "null" - ] - } + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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": [ - "state", - "review_id", - "dismissal_message" - ] - }, - "milestone": { - "title": "Issue Event Milestone", - "description": "Issue Event Milestone", - "type": "object", - "properties": { - "title": { - "type": "string" - } + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" }, - "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" - } + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] }, - "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": { + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { "type": "string" } }, - "required": [ - "from", - "to" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "OWNER" - ] - }, - "lock_reason": { - "type": [ - "string", - "null" - ] + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + "required": [ + "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": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:14:43Z" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri" - } + "email": { + "type": [ + "string", + "null" + ] }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - "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", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "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", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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.", - "type": "array", - "items": { + "metadata": { "type": "string" }, - "examples": [ - "label", - "deployment" - ] + "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.", - "type": "integer", - "examples": [ - 5 - ] + "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.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "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", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "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=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "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" + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "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" + } } } } - }, - "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" @@ -357665,82 +370423,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", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "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": [ { @@ -357762,7 +370502,8 @@ } }, { - "name": "event_id", + "name": "issue_number", + "description": "The number that identifies the issue.", "in": "path", "required": true, "schema": { @@ -357770,37 +370511,249 @@ } } ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "integer" + } + ], + "description": "The title of the issue.", + "type": [ + "null", + "string", + "integer" + ] + }, + "body": { + "type": [ + "string", + "null" + ], + "description": "The contents of the issue." + }, + "assignee": { + "type": [ + "string", + "null" + ], + "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", + "null" + ], + "enum": [ + "completed", + "not_planned", + "duplicate", + "reopened", + null + ], + "description": "The reason for the state change. Ignored unless `state` is changed.", + "examples": [ + "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." + } + ], + "type": [ + "null", + "string", + "integer" + ] + }, + "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", + "null" + ] + }, + "color": { + "type": [ + "string", + "null" + ] + } + } + } + ] + } + }, + "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", + "null" + ], + "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.", + "examples": [ + "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", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri", "examples": [ - 1 + "https://api.github.com/repositories/42/issues/1" ] }, - "node_id": { + "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", + "type": "integer", "examples": [ - "MDEwOklzc3VlRXZlbnQx" + 42 ] }, - "url": { + "state": { + "description": "State of the issue; either 'open' or 'closed'", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/issues/events/1" + "open" ] }, - "actor": { + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate", + null + ], + "examples": [ + "not_planned" + ] + }, + "title": { + "description": "Title of the issue", + "type": "string", + "examples": [ + "Widget creation fails in Safari on OS X 10.8" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ], + "examples": [ + "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?" + ] + }, + "user": { "anyOf": [ { "type": "null" @@ -357975,1474 +370928,488 @@ } ] }, - "event": { - "type": "string", - "examples": [ - "closed" - ] - }, - "commit_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "commit_url": { - "type": [ - "string", - "null" - ], - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", + "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", + "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", + "null" + ] + }, + "color": { + "type": [ + "string", + "null" + ] + }, + "default": { + "type": "boolean" + } + } + } + ] + }, "examples": [ - "2011-04-14T16:00:49Z" + "bug", + "registration" ] }, - "issue": { + "assignee": { "anyOf": [ { "type": "null" }, { - "title": "Issue", - "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, "id": { "type": "integer", - "format": "int64" + "format": "int64", + "examples": [ + 1 + ] }, "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/repositories/42/issues/1" + "MDQ6VXNlcjE=" ] }, - "repository_url": { + "avatar_url": { "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string" + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, - "comments_url": { - "type": "string", - "format": "uri" + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] }, - "events_url": { + "url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] }, "html_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "type": "integer", + "followers_url": { + "type": "string", + "format": "uri", "examples": [ - 42 + "https://api.github.com/users/octocat/followers" ] }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", + "following_url": { "type": "string", "examples": [ - "open" + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ], + "gists_url": { + "type": "string", "examples": [ - "not_planned" + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "title": { - "description": "Title of the issue", + "starred_url": { "type": "string", "examples": [ - "Widget creation fails in Safari on OS X 10.8" + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ], + "subscriptions_url": { + "type": "string", + "format": "uri", "examples": [ - "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?" + "https://api.github.com/users/octocat/subscriptions" ] }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" ] }, - "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", - "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", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - }, - "default": { - "type": "boolean" - } - } - } - ] - }, + "repos_url": { + "type": "string", + "format": "uri", "examples": [ - "bug", - "registration" + "https://api.github.com/users/octocat/repos" ] }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "assignees": { - "type": [ - "array", - "null" - ], - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/milestones/v1.0" - ] - }, - "labels_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDk6TWlsZXN0b25lMTAwMjYwNA==" - ] - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "examples": [ - 42 - ] - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open", - "examples": [ - "open" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string", - "examples": [ - "v1.0" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "Tracking milestone for version 1.0" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 4 - ] - }, - "closed_issues": { - "type": "integer", - "examples": [ - 8 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2013-02-12T13:22:01Z" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2012-10-09T23:39:01Z" - ] - } - }, - "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" - ] - } + "type": { + "type": "string", + "examples": [ + "User" ] }, - "locked": { + "site_admin": { "type": "boolean" }, - "active_lock_reason": { - "type": [ - "string", - "null" + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" ] }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "assignees": { + "type": [ + "array", + "null" + ], + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" ] }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { + "html_url": { "type": "string", - "format": "date-time" + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] }, - "updated_at": { + "labels_url": { "type": "string", - "format": "date-time" + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] }, - "draft": { - "type": "boolean" + "id": { + "type": "integer", + "examples": [ + 1002604 + ] }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 ] }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] }, - "timeline_url": { + "title": { + "description": "The title of the milestone.", "type": "string", - "format": "uri" + "examples": [ + "v1.0" + ] }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", + "description": { "type": [ - "object", + "string", "null" ], - "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", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "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": [ + "Tracking milestone for version 1.0" ] }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] + "creator": { + "anyOf": [ + { + "type": "null" }, - "owner": { + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -359609,1209 +371576,2656 @@ "type", "url" ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] + } + }, + "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" + ] + } + ] + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "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", + "null" + ], + "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", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "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", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { "type": "string", - "format": "uri", "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" + "mit" ] }, - "svn_url": { + "name": { "type": "string", - "format": "uri", "examples": [ - "https://svn.github.com/octocat/Hello-World" + "MIT License" ] }, - "homepage": { + "url": { "type": [ "string", "null" ], "format": "uri", "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" + "https://api.github.com/licenses/mit" ] }, - "updated_at": { + "spdx_id": { "type": [ "string", "null" ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", "examples": [ - false + "MIT" ] }, - "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": { + "node_id": { "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", "examples": [ - true + "MDc6TGljZW5zZW1pdA==" ] }, - "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": { + "html_url": { "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } + "format": "uri" } }, "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", + "key", "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" + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 ] }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ { - "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", - "null" - ], + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, "id": { - "description": "Unique identifier of the GitHub app", "type": "integer", + "format": "int64", "examples": [ - 37 + 1 ] }, - "slug": { - "description": "The slug name of the GitHub app", + "node_id": { "type": "string", "examples": [ - "probot-owners" + "MDQ6VXNlcjE=" ] }, - "node_id": { + "avatar_url": { "type": "string", + "format": "uri", "examples": [ - "MDExOkludGVncmF0aW9uMQ==" + "https://github.com/images/error/octocat_happy.gif" ] }, - "client_id": { + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { "type": "string", + "format": "uri", "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" + "https://api.github.com/users/octocat" ] }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "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" - ] - } + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" ] }, - "name": { - "description": "The name of the GitHub app", + "followers_url": { "type": "string", + "format": "uri", "examples": [ - "Probot Owners" + "https://api.github.com/users/octocat/followers" ] }, - "description": { - "type": [ - "string", - "null" - ], + "following_url": { + "type": "string", "examples": [ - "The description of the app." + "https://api.github.com/users/octocat/following{/other_user}" ] }, - "external_url": { + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { "type": "string", "format": "uri", "examples": [ - "https://example.com" + "https://api.github.com/users/octocat/subscriptions" ] }, - "html_url": { + "organizations_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/apps/super-ci" + "https://api.github.com/users/octocat/orgs" ] }, - "created_at": { + "repos_url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2017-07-08T16:18:44-04:00" + "https://api.github.com/users/octocat/repos" ] }, - "updated_at": { + "events_url": { "type": "string", - "format": "date-time", "examples": [ - "2017-07-08T16:18:44-04:00" + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "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" - } + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_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.", - "type": "array", - "items": { - "type": "string" - }, + "type": { + "type": "string", "examples": [ - "label", - "deployment" + "User" ] }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", "type": "integer", "examples": [ - 5 + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" ] + }, + "avatar_url": { + "type": "string", + "format": "uri" } }, "required": [ "id", "node_id", - "owner", "name", - "description", - "external_url", + "slug", "html_url", "created_at", "updated_at", - "permissions", - "events" + "avatar_url" ] } ] }, - "author_association": { - "title": "author_association", + "name": { + "description": "The name of the GitHub app", "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" ], "examples": [ - "OWNER" + "The description of the app." ] }, - "reactions": { - "title": "Reaction Rollup", + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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" - ] + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "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.", + "type": "array", + "items": { + "type": "string" }, - "required": [ - "total", - "completed", - "percent_completed" + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 ] } }, "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" ] } ] }, - "label": { - "title": "Issue Event Label", - "description": "Issue Event Label", + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] + "url": { + "type": "string", + "format": "uri" }, - "color": { - "type": [ - "string", - "null" - ] + "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": [ - "name", - "color" + "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=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/1" + ] + }, + "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", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate", + null + ], + "examples": [ + "not_planned" + ] + }, + "title": { + "description": "Title of the issue", + "type": "string", + "examples": [ + "Widget creation fails in Safari on OS X 10.8" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ], + "examples": [ + "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?" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "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", + "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", + "null" + ] + }, + "color": { + "type": [ + "string", + "null" + ] + }, + "default": { + "type": "boolean" + } + } + } + ] + }, + "examples": [ + "bug", + "registration" ] }, "assignee": { @@ -360875,296 +374289,692 @@ "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "assignees": { + "type": [ + "array", + "null" + ], + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "https://github.com/octocat/Hello-World/milestones/v1.0" ] }, - "organizations_url": { + "labels_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/orgs" + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" ] }, - "repos_url": { - "type": "string", - "format": "uri", + "id": { + "type": "integer", "examples": [ - "https://api.github.com/users/octocat/repos" + 1002604 ] }, - "events_url": { + "node_id": { "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "MDk6TWlsZXN0b25lMTAwMjYwNA==" ] }, - "received_events_url": { - "type": "string", - "format": "uri", + "number": { + "description": "The number of the milestone.", + "type": "integer", "examples": [ - "https://api.github.com/users/octocat/received_events" + 42 ] }, - "type": { + "state": { + "description": "The state of the milestone.", "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", "examples": [ - "User" + "open" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { + "title": { + "description": "The title of the milestone.", "type": "string", "examples": [ - "\"2020-07-09T00:17:55Z\"" + "v1.0" ] }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "assigner": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { + "description": { "type": [ "string", "null" + ], + "examples": [ + "Tracking milestone for version 1.0" ] }, - "email": { - "type": [ - "string", - "null" + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } ] }, - "login": { - "type": "string", + "open_issues": { + "type": "integer", "examples": [ - "octocat" + 4 ] }, - "id": { + "closed_issues": { "type": "integer", - "format": "int64", "examples": [ - 1 + 8 ] }, - "node_id": { + "created_at": { "type": "string", + "format": "date-time", "examples": [ - "MDQ6VXNlcjE=" + "2011-04-10T20:09:31Z" ] }, - "avatar_url": { + "updated_at": { "type": "string", - "format": "uri", + "format": "date-time", "examples": [ - "https://github.com/images/error/octocat_happy.gif" + "2014-03-03T18:58:10Z" ] }, - "gravatar_id": { + "closed_at": { "type": [ "string", "null" ], + "format": "date-time", "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" + "2013-02-12T13:22:01Z" ] }, - "user_view_type": { - "type": "string", + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", "examples": [ - "public" + "2012-10-09T23:39:01Z" ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" ] } ] }, - "review_requester": { + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { "anyOf": [ { "type": "null" @@ -361339,12 +375149,206 @@ } ] }, - "requested_reviewer": { - "anyOf": [ - { - "type": "null" + "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", + "null" + ], + "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", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "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", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -361511,334 +375515,664 @@ "type", "url" ] - } - ] - }, - "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" + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" }, - "slug": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] }, "description": { "type": [ "string", "null" + ], + "examples": [ + "This your first repo!" ] }, - "privacy": { - "type": "string" + "fork": { + "type": "boolean" }, - "notification_setting": { - "type": "string" + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] }, - "permission": { - "type": "string" + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] }, - "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" + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, - "url": { + "blobs_url": { "type": "string", - "format": "uri" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] }, - "html_url": { + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/orgs/rails/teams/core" + "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, - "members_url": { - "type": "string" + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] }, - "repositories_url": { + "downloads_url": { "type": "string", - "format": "uri" + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] - } + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" ] - } - }, - "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": { + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", "type": "string" }, - "review_id": { - "type": "integer" + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] }, - "dismissal_message": { + "created_at": { "type": [ "string", "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" ] }, - "dismissal_commit_id": { + "updated_at": { "type": [ "string", "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" ] - } - }, - "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", + "examples": [ + 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", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { "type": "string", - "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", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { "type": "integer" }, - "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", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } } }, "required": [ - "from", - "to" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "OWNER" - ] - }, - "lock_reason": { - "type": [ - "string", - "null" + "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": { @@ -362248,26 +376582,159 @@ ] } ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "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=", @@ -362287,24 +376754,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=", @@ -362323,19 +376805,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=", @@ -362355,198 +376837,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" } } } @@ -362558,21 +376889,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": [ { @@ -362603,6 +376932,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", @@ -364784,86 +379141,2122 @@ "lexical_search_ok": { "type": "boolean" }, - "lexical_commit_sha": { - "type": "string" + "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": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "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", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "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=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "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" + } + } + } + } + } + } + }, + "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" + } + }, + { + "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": { + "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": "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", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/comments/1" + ] + }, + "body": { + "description": "Contents of the issue comment", + "type": "string", + "examples": [ + "What version of Safari were you using when you observed this bug?" + ] + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + }, + "performed_via_github_app": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "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", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "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", + "content": { + "application/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", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/comments/1" + ] + }, + "body": { + "description": "Contents of the issue comment", + "type": "string", + "examples": [ + "What version of Safari were you using when you observed this bug?" + ] + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] } - }, - "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" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-14T16:00:49Z" + ] + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" ] }, "performed_via_github_app": { @@ -365274,24 +381667,6 @@ } ] }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "OWNER" - ] - }, "reactions": { "title": "Reaction Rollup", "type": "object", @@ -365340,48 +381715,16 @@ "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", + "html_url", + "issue_url", "author_association", + "user", + "url", "created_at", "updated_at" ] @@ -365390,17 +381733,10 @@ "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.", + "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, @@ -365421,138 +381757,26 @@ "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" + "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" + } + } } }, - "301": { - "description": "Moved permanently", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -365577,8 +381801,8 @@ } } }, - "404": { - "description": "Resource not found", + "410": { + "description": "Gone", "content": { "application/json": { "schema": { @@ -365603,8 +381827,83 @@ } } }, - "410": { - "description": "Gone", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -365628,28 +381927,28 @@ } } } - }, - "304": { - "description": "Not modified" } }, "x-github": { + "triggersNotification": true, "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`.", + } + }, + "/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/update", + "operationId": "issues/list-dependencies-blocked-by", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/issues#update-an-issue" + "url": "https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by" }, "parameters": [ { @@ -365678,1595 +381977,525 @@ "schema": { "type": "integer" } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "title": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ], - "description": "The title of the issue.", - "type": [ - "null", - "string", - "integer" - ] - }, - "body": { - "type": [ - "string", - "null" - ], - "description": "The contents of the issue." - }, - "assignee": { - "type": [ - "string", - "null" - ], - "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", - "null" - ], - "enum": [ - "completed", - "not_planned", - "duplicate", - "reopened", - null - ], - "description": "The reason for the state change. Ignored unless `state` is changed.", - "examples": [ - "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." - } - ], - "type": [ - "null", - "string", - "integer" - ] - }, - "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", - "null" - ] - }, - "color": { - "type": [ - "string", - "null" - ] - } - } - } - ] - } - }, - "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", - "null" - ], - "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.", - "examples": [ - "Epic" - ] - } - } - }, - "examples": { - "default": { - "value": { - "title": "Found a bug", - "body": "I'm having a problem with this.", - "assignees": [ - "octocat" - ], - "milestone": 1, - "state": "open", - "labels": [ - "bug" - ] - } - } - } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 } } - }, + ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "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", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/issues/1" - ] - }, - "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", - "type": "integer", - "examples": [ - 42 - ] - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "state_reason": { - "description": "The reason for the current state", - "type": [ - "string", - "null" - ], - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate", - null - ], - "examples": [ - "not_planned" - ] - }, - "title": { - "description": "Title of the issue", - "type": "string", - "examples": [ - "Widget creation fails in Safari on OS X 10.8" - ] - }, - "body": { - "description": "Contents of the issue", - "type": [ - "string", - "null" - ], - "examples": [ - "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?" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "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", - "type": "array", - "items": { - "oneOf": [ + "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", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/1" + ] + }, + "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", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate", + null + ], + "examples": [ + "not_planned" + ] + }, + "title": { + "description": "Title of the issue", + "type": "string", + "examples": [ + "Widget creation fails in Safari on OS X 10.8" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ], + "examples": [ + "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?" + ] + }, + "user": { + "anyOf": [ { - "type": "string" + "type": "null" }, { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, "id": { "type": "integer", - "format": "int64" + "format": "int64", + "examples": [ + 1 + ] }, "node_id": { - "type": "string" - }, - "url": { "type": "string", - "format": "uri" + "examples": [ + "MDQ6VXNlcjE=" + ] }, - "name": { - "type": "string" + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] }, - "description": { + "gravatar_id": { "type": [ "string", "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" ] }, - "color": { - "type": [ - "string", - "null" + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" ] }, - "default": { - "type": "boolean" - } - } - } - ] - }, - "examples": [ - "bug", - "registration" - ] - }, - "assignee": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "assignees": { - "type": [ - "array", - "null" - ], - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "milestone": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/milestones/v1.0" - ] - }, - "labels_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDk6TWlsZXN0b25lMTAwMjYwNA==" - ] - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "examples": [ - 42 - ] - }, - "state": { - "description": "The state of the milestone.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open", - "examples": [ - "open" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string", - "examples": [ - "v1.0" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "Tracking milestone for version 1.0" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 4 - ] - }, - "closed_issues": { - "type": "integer", - "examples": [ - 8 - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2013-02-12T13:22:01Z" - ] - }, - "due_on": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2012-10-09T23:39:01Z" - ] - } - }, - "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" - ] - } - ] - }, - "locked": { - "type": "boolean" - }, - "active_lock_reason": { - "type": [ - "string", - "null" - ] - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "diff_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "patch_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "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", - "null" - ], - "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", - "null" - ], - "description": "The description of the issue type." - }, - "color": { - "type": [ - "string", - "null" - ], - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple", - null - ] - }, - "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": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_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", - "name", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ + "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", + "type": "array", + "items": { + "oneOf": [ { - "type": "null" + "type": "string" }, { - "title": "License Simple", - "description": "License Simple", "type": "object", "properties": { - "key": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { "type": "string", - "examples": [ - "mit" - ] + "format": "uri" }, "name": { - "type": "string", - "examples": [ - "MIT License" - ] + "type": "string" }, - "url": { + "description": { "type": [ "string", "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" ] }, - "spdx_id": { + "color": { "type": [ "string", "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" ] }, - "html_url": { - "type": "string", - "format": "uri" + "default": { + "type": "boolean" } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] + } } ] }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } + "examples": [ + "bug", + "registration" + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "assignees": { + "type": [ + "array", + "null" + ], + "items": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -367433,1254 +382662,2168 @@ "type", "url" ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" + } + }, + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string", + "examples": [ + "v1.0" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] + } + }, + "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" + ] + } + ] + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": [ + "string", + "null" + ] + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" } }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "deprecated": true, - "examples": [ - true - ] - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "examples": [ - false - ] - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "examples": [ - true - ] - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:42Z\"" - ] - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "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", + "null" + ], + "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", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "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", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } }, - "lexical_commit_sha": { + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { "type": "string" } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } } - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "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": { + "anyOf": [ + { + "type": "null" + }, + { + "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", + "null" + ], + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_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", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "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", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "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", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] }, - "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.", + "type": "integer", + "examples": [ + 5 + ] } }, - "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.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 - ] - } + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "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" + "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" + } }, - "rocket": { - "type": "integer" - } + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] }, - "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" + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } }, - "percent_completed": { - "type": "integer" - } + "required": [ + "total", + "completed", + "percent_completed" + ] }, - "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" - ] + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_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", + "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=", @@ -368699,19 +384842,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=", @@ -368731,171 +384874,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", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "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" } } } @@ -368983,21 +385065,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": [ { @@ -369029,28 +385109,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 } } } @@ -371814,6 +387891,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": [ @@ -372003,26 +388104,216 @@ } } } + }, + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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/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": [ { @@ -372051,36 +388342,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", @@ -374645,605 +390917,1746 @@ } ] }, - "name": { - "description": "The name of the GitHub app", + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "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.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "type": "integer", + "examples": [ + 5 + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "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=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "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" + } + } + } + } + } + }, + "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "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" + } + } + } + } + } + }, + "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": { + "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": [ + { + "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", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repositories/42/issues/1" + ] + }, + "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", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "state_reason": { + "description": "The reason for the current state", + "type": [ + "string", + "null" + ], + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate", + null + ], + "examples": [ + "not_planned" + ] + }, + "title": { + "description": "Title of the issue", + "type": "string", + "examples": [ + "Widget creation fails in Safari on OS X 10.8" + ] + }, + "body": { + "description": "Contents of the issue", + "type": [ + "string", + "null" + ], + "examples": [ + "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?" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "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", + "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", + "null" + ] + }, + "color": { + "type": [ + "string", + "null" + ] + }, + "default": { + "type": "boolean" + } + } + } + ] + }, + "examples": [ + "bug", + "registration" + ] + }, + "assignee": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "assignees": { + "type": [ + "array", + "null" + ], + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { "type": "string", "examples": [ - "Probot Owners" + "https://api.github.com/users/octocat/gists{/gist_id}" ] }, - "description": { - "type": [ - "string", - "null" - ], + "starred_url": { + "type": "string", "examples": [ - "The description of the app." + "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, - "external_url": { + "subscriptions_url": { "type": "string", "format": "uri", "examples": [ - "https://example.com" + "https://api.github.com/users/octocat/subscriptions" ] }, - "html_url": { + "organizations_url": { "type": "string", "format": "uri", "examples": [ - "https://github.com/apps/super-ci" + "https://api.github.com/users/octocat/orgs" ] }, - "created_at": { + "repos_url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2017-07-08T16:18:44-04:00" + "https://api.github.com/users/octocat/repos" ] }, - "updated_at": { + "events_url": { "type": "string", - "format": "date-time", "examples": [ - "2017-07-08T16:18:44-04:00" + "https://api.github.com/users/octocat/events{/privacy}" ] }, - "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" - } + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_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.", - "type": "array", - "items": { - "type": "string" - }, + "type": { + "type": "string", "examples": [ - "label", - "deployment" + "User" ] }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", "examples": [ - 5 + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" ] } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", "id", "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] } - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "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" - } + "milestone": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string", + "examples": [ + "v1.0" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2013-02-12T13:22:01Z" + ] + }, + "due_on": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2012-10-09T23:39:01Z" + ] + } + }, + "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" + ] + } + ] }, - "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" - ] - }, - "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 + "locked": { + "type": "boolean" }, - "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 + "active_lock_reason": { + "type": [ + "string", + "null" + ] }, - "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" + "comments": { + "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" - }, - "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" - } - } - } - } - } - } - }, - "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" - } - }, - { - "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": { - "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": "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", - "type": "integer", - "format": "int64", - "examples": [ - 42 + "type": "object", + "properties": { + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + }, + "diff_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "patch_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" ] }, - "node_id": { - "type": "string" + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" }, - "url": { - "description": "URL for the issue comment", + "created_at": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/issues/comments/1" - ] + "format": "date-time" }, - "body": { - "description": "Contents of the issue comment", + "updated_at": { "type": "string", - "examples": [ - "What version of Safari were you using when you observed this bug?" - ] - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" + "format": "date-time" }, - "html_url": { - "type": "string", - "format": "uri" + "draft": { + "type": "boolean" }, - "user": { + "closed_by": { "anyOf": [ { "type": "null" @@ -375418,40 +392831,1030 @@ } ] }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] + "body_html": { + "type": "string" }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] + "body_text": { + "type": "string" }, - "issue_url": { + "timeline_url": { "type": "string", "format": "uri" }, - "author_association": { - "title": "author_association", - "type": "string", - "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", + "null" ], - "examples": [ - "OWNER" + "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", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "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", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "deprecated": true, + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" ] }, "performed_via_github_app": { @@ -375862,6 +394265,24 @@ } ] }, + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ], + "examples": [ + "OWNER" + ] + }, "reactions": { "title": "Reaction Rollup", "type": "object", @@ -375910,16 +394331,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" ] @@ -375930,10 +394407,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, @@ -375954,10 +394438,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" } ] } @@ -375973,34 +394577,8 @@ } } }, - "404": { - "description": "Resource not found", - "content": { - "application/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", + "301": { + "description": "Moved permanently", "content": { "application/json": { "schema": { @@ -376024,856 +394602,9 @@ } } } - } - }, - "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", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repositories/42/issues/comments/1" - ] - }, - "body": { - "description": "Contents of the issue comment", - "type": "string", - "examples": [ - "What version of Safari were you using when you observed this bug?" - ] - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-14T16:00:49Z" - ] - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ], - "examples": [ - "OWNER" - ] - }, - "performed_via_github_app": { - "anyOf": [ - { - "type": "null" - }, - { - "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", - "null" - ], - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "type": "integer", - "examples": [ - 37 - ] - }, - "slug": { - "description": "The slug name of the GitHub app", - "type": "string", - "examples": [ - "probot-owners" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOkludGVncmF0aW9uMQ==" - ] - }, - "client_id": { - "type": "string", - "examples": [ - "\"Iv1.25b5d1e65ffc4022\"" - ] - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": [ - "string", - "null" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/octo-business" - ] - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "examples": [ - "Octo Business" - ] - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "examples": [ - "octo-business" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2019-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "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", - "type": "string", - "examples": [ - "Probot Owners" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "The description of the app." - ] - }, - "external_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://example.com" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/apps/super-ci" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2017-07-08T16:18:44-04:00" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "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.", - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "label", - "deployment" - ] - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "type": "integer", - "examples": [ - 5 - ] - } - }, - "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", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -376923,115 +394654,13 @@ } } } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/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" } } }, @@ -394218,6 +411847,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": [ @@ -397339,6 +414992,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": [ @@ -400428,6 +418105,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": [ @@ -403622,6 +421323,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": [ @@ -417222,6 +434947,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": [ @@ -533644,6 +551393,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" }, @@ -586118,6 +603891,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": [ @@ -621404,6 +639201,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": [ @@ -625207,6 +643028,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": [ @@ -629012,6 +646857,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": [ @@ -640192,6 +658061,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": [ @@ -643997,6 +661890,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": [ @@ -838328,6 +856245,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", @@ -842610,6 +860551,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", @@ -846916,6 +864881,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", @@ -852111,6 +870100,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": [ @@ -854893,6 +872906,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": [ @@ -860518,6 +878555,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": [ @@ -863300,6 +881361,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": [ @@ -868925,6 +887010,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": [ @@ -872656,6 +890765,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": [ @@ -877332,6 +895465,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": [ @@ -881063,6 +899220,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": [ @@ -884308,6 +902489,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", @@ -887625,6 +905830,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", @@ -891150,6 +909379,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", @@ -894479,6 +912732,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", @@ -897989,6 +916266,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", @@ -901342,6 +919643,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", @@ -904723,6 +923048,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", @@ -908028,6 +926377,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", @@ -911395,6 +929768,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", @@ -913455,6 +931852,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", @@ -916760,6 +935181,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", @@ -920092,6 +938537,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", @@ -923263,6 +941732,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", @@ -925339,6 +943832,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", @@ -928651,6 +947168,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", @@ -932132,6 +950673,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", @@ -935444,6 +954009,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", @@ -938823,6 +957412,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", @@ -942105,6 +960718,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", @@ -945416,6 +964053,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", @@ -1051112,6 +1069773,266 @@ ] } ] + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "latest_status_update": { + "anyOf": [ + { + "type": "null" + }, + { + "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": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "status": { + "type": [ + "string", + "null" + ], + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + "start_date": { + "type": "string", + "format": "date", + "examples": [ + "2022-04-28" + ] + }, + "target_date": { + "type": "string", + "format": "date", + "examples": [ + "2022-04-28" + ] + }, + "body": { + "description": "Body of the status update", + "type": [ + "string", + "null" + ], + "examples": [ + "The project is off to a great start!" + ] + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ] + } + ] + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" } }, "required": [ @@ -1052106,6 +1071027,266 @@ ] } ] + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "latest_status_update": { + "anyOf": [ + { + "type": "null" + }, + { + "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": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "status": { + "type": [ + "string", + "null" + ], + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + "start_date": { + "type": "string", + "format": "date", + "examples": [ + "2022-04-28" + ] + }, + "target_date": { + "type": "string", + "format": "date", + "examples": [ + "2022-04-28" + ] + }, + "body": { + "description": "Body of the status update", + "type": [ + "string", + "null" + ], + "examples": [ + "The project is off to a great start!" + ] + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ] + } + ] + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" } }, "required": [ @@ -1053100,6 +1072281,266 @@ ] } ] + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "latest_status_update": { + "anyOf": [ + { + "type": "null" + }, + { + "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": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "status": { + "type": [ + "string", + "null" + ], + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + "start_date": { + "type": "string", + "format": "date", + "examples": [ + "2022-04-28" + ] + }, + "target_date": { + "type": "string", + "format": "date", + "examples": [ + "2022-04-28" + ] + }, + "body": { + "description": "Body of the status update", + "type": [ + "string", + "null" + ], + "examples": [ + "The project is off to a great start!" + ] + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ] + } + ] + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" } }, "required": [ @@ -1054155,6 +1073596,266 @@ ] } ] + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "latest_status_update": { + "anyOf": [ + { + "type": "null" + }, + { + "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": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "status": { + "type": [ + "string", + "null" + ], + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + "start_date": { + "type": "string", + "format": "date", + "examples": [ + "2022-04-28" + ] + }, + "target_date": { + "type": "string", + "format": "date", + "examples": [ + "2022-04-28" + ] + }, + "body": { + "description": "Body of the status update", + "type": [ + "string", + "null" + ], + "examples": [ + "The project is off to a great start!" + ] + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ] + } + ] + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" } }, "required": [ @@ -1059842,6 +1079543,266 @@ ] } ] + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "latest_status_update": { + "anyOf": [ + { + "type": "null" + }, + { + "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": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "status": { + "type": [ + "string", + "null" + ], + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ] + }, + "start_date": { + "type": "string", + "format": "date", + "examples": [ + "2022-04-28" + ] + }, + "target_date": { + "type": "string", + "format": "date", + "examples": [ + "2022-04-28" + ] + }, + "body": { + "description": "Body of the status update", + "type": [ + "string", + "null" + ], + "examples": [ + "The project is off to a great start!" + ] + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ] + } + ] + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" } }, "required": [ @@ -1358176,6 +1378137,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": [ @@ -1361907,6 +1381892,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": [ @@ -1366580,6 +1386589,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": [ @@ -1370311,6 +1390344,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": [ @@ -1374984,6 +1395041,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": [ @@ -1378715,6 +1398796,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": [ @@ -1383388,6 +1403493,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": [ @@ -1387119,6 +1407248,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-next/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml index f90ef74520..267186ebf3 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml @@ -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: @@ -901,7 +903,7 @@ paths: - subscriptions_url - type - url - type: &267 + type: &272 type: string description: The type of credit the user is receiving. enum: @@ -1034,7 +1036,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &95 + schema: &98 title: Validation Error Simple description: Validation Error Simple type: object @@ -1067,7 +1069,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &580 + - &590 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1652,7 +1654,7 @@ paths: schema: type: integer default: 30 - - &164 + - &167 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 @@ -1668,7 +1670,7 @@ paths: application/json: schema: type: array - items: &165 + items: &168 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1764,7 +1766,7 @@ paths: - installation_id - repository_id examples: - default: &166 + default: &169 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1827,7 +1829,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &94 + schema: &97 title: Validation Error description: Validation Error type: object @@ -1899,7 +1901,7 @@ paths: description: Response content: application/json: - schema: &167 + schema: &170 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -2034,7 +2036,7 @@ paths: - request - response examples: - default: &168 + default: &171 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -5382,7 +5384,7 @@ paths: responses: '202': *37 '422': *7 - '500': &91 + '500': &94 description: Internal Error content: application/json: @@ -7713,7 +7715,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: &138 + code_scanning_options: &141 type: - object - 'null' @@ -7911,7 +7913,7 @@ paths: description: Response content: application/json: - schema: &140 + schema: &143 type: array description: A list of default code security configurations items: @@ -7927,7 +7929,7 @@ paths: default configuration: *41 examples: - default: &141 + default: &144 value: - default_for_new_repos: public configuration: @@ -8258,7 +8260,7 @@ paths: - *40 - *43 responses: - '204': &142 + '204': &145 description: A header with no content is returned. '400': *14 '403': *27 @@ -8385,7 +8387,7 @@ paths: default: value: default_for_new_repos: all - configuration: &139 + configuration: &142 value: id: 1325 target_type: organization @@ -8470,7 +8472,7 @@ paths: application/json: schema: type: array - items: &143 + items: &146 type: object description: Repositories associated with a code security configuration and attachment status @@ -8815,7 +8817,7 @@ paths: summary: Example of code security configuration repositories value: - status: attached - repository: &144 + repository: &147 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -8909,7 +8911,7 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *40 - - &148 + - &151 name: state in: query description: |- @@ -8918,7 +8920,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &149 + - &152 name: severity in: query description: |- @@ -8927,7 +8929,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &150 + - &153 name: ecosystem in: query description: |- @@ -8936,14 +8938,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &151 + - &154 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 - - &152 + - &155 name: epss_percentage in: query description: |- @@ -8955,7 +8957,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 - - &153 + - &156 name: has in: query description: |- @@ -8969,7 +8971,7 @@ paths: type: string enum: - patch - - &154 + - &157 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -8979,7 +8981,7 @@ paths: enum: - development - runtime - - &155 + - &158 name: sort in: query description: |- @@ -8997,7 +8999,7 @@ paths: - *46 - *38 - *39 - - &156 + - &159 name: first description: |- **Deprecated**. The number of results per page (max 100), starting from the first matching result. @@ -9010,7 +9012,7 @@ paths: minimum: 1 maximum: 100 default: 30 - - &157 + - &160 name: last description: |- **Deprecated**. The number of results per page (max 100), starting from the last matching result. @@ -9030,7 +9032,7 @@ paths: application/json: schema: type: array - items: &158 + items: &161 type: object description: A Dependabot alert. properties: @@ -9100,7 +9102,7 @@ paths: - direct - transitive - - security_advisory: &433 + security_advisory: &443 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -9329,7 +9331,7 @@ paths: 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissed_at: &134 + dismissed_at: &137 type: - string - 'null' @@ -9360,7 +9362,7 @@ paths: description: An optional comment associated with the alert's dismissal. maxLength: 280 - fixed_at: &133 + fixed_at: &136 type: - string - 'null' @@ -9368,7 +9370,7 @@ paths: and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - auto_dismissed_at: &434 + auto_dismissed_at: &444 type: - string - 'null' @@ -9395,7 +9397,7 @@ paths: - repository additionalProperties: false examples: - default: &159 + default: &162 value: - number: 2 state: dismissed @@ -9742,7 +9744,7 @@ paths: url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise parameters: - *40 - - &257 + - &260 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -9753,7 +9755,7 @@ paths: enum: - open - resolved - - &258 + - &261 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -9763,7 +9765,7 @@ paths: required: false schema: type: string - - &259 + - &262 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -9772,7 +9774,7 @@ paths: required: false schema: type: string - - &260 + - &263 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. @@ -9788,7 +9790,7 @@ paths: - *17 - *38 - *39 - - &261 + - &264 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -9797,7 +9799,7 @@ paths: required: false schema: type: string - - &262 + - &265 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -9806,7 +9808,7 @@ paths: schema: type: boolean default: false - - &263 + - &266 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -9815,7 +9817,7 @@ paths: schema: type: boolean default: false - - &264 + - &267 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -9831,7 +9833,7 @@ paths: application/json: schema: type: array - items: &265 + items: &268 type: object properties: number: *52 @@ -9847,14 +9849,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &558 + state: &568 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: &559 + resolution: &569 type: - string - 'null' @@ -9961,14 +9963,14 @@ paths: first_location_detected: anyOf: - type: 'null' - - &560 + - &570 description: 'Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. ' oneOf: - - &562 + - &572 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -10025,7 +10027,7 @@ paths: - blob_url - commit_sha - commit_url - - &563 + - &573 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. @@ -10086,7 +10088,7 @@ paths: - page_url - commit_sha - commit_url - - &564 + - &574 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -10101,7 +10103,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_title_url - - &565 + - &575 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -10116,7 +10118,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_body_url - - &566 + - &576 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -10131,7 +10133,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - issue_comment_url - - &567 + - &577 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -10146,7 +10148,7 @@ paths: - https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &568 + - &578 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -10161,7 +10163,7 @@ paths: - https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &569 + - &579 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -10176,7 +10178,7 @@ paths: - https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &570 + - &580 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. @@ -10191,7 +10193,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_title_url - - &571 + - &581 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. @@ -10206,7 +10208,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_body_url - - &572 + - &582 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. @@ -10221,7 +10223,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - pull_request_comment_url - - &573 + - &583 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. @@ -10236,7 +10238,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 required: - pull_request_review_url - - &574 + - &584 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 @@ -10257,7 +10259,7 @@ paths: description: A boolean value representing whether or not the token in the alert was detected in more than one location. examples: - default: &266 + default: &269 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -10727,7 +10729,7 @@ paths: milestone: anyOf: - type: 'null' - - &421 + - &431 title: Milestone description: A collection of related issues and pull requests. @@ -10899,7 +10901,7 @@ paths: timeline_url: type: string format: uri - type: &186 + type: &189 title: Issue Type description: The type of issue. type: @@ -11008,7 +11010,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &592 + sub_issues_summary: &602 title: Sub-issues Summary type: object properties: @@ -11022,6 +11024,23 @@ paths: - total - completed - percent_completed + issue_dependencies_summary: &603 + title: Issue Dependencies Summary + type: object + properties: + blocked_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 @@ -11044,7 +11063,7 @@ paths: - author_association - created_at - updated_at - comment: &480 + comment: &490 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -11619,7 +11638,7 @@ paths: url: type: string format: uri - user: &604 + user: &615 title: Public User description: Public User type: object @@ -13514,7 +13533,7 @@ paths: - closed - all default: open - - &189 + - &192 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -13565,7 +13584,7 @@ paths: type: array items: *74 examples: - default: &190 + default: &193 value: - id: 1 node_id: MDU6SXNzdWUx @@ -14977,14 +14996,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &289 + - &294 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &290 + - &295 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -15055,7 +15074,7 @@ paths: '404': *6 '403': *27 '304': *35 - '301': &301 + '301': &306 description: Moved permanently content: application/json: @@ -15077,7 +15096,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &509 + - &519 name: all description: If `true`, show notifications marked as read. in: query @@ -15085,7 +15104,7 @@ paths: schema: type: boolean default: false - - &510 + - &520 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -15095,7 +15114,7 @@ paths: type: boolean default: false - *64 - - &511 + - &521 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: @@ -15127,7 +15146,7 @@ paths: properties: id: type: string - repository: &116 + repository: &119 title: Minimal Repository description: Minimal Repository type: object @@ -15466,7 +15485,7 @@ paths: type: boolean examples: - false - security_and_analysis: &227 + security_and_analysis: &230 type: - object - 'null' @@ -15631,7 +15650,7 @@ paths: - url - subscription_url examples: - default: &512 + default: &522 value: - id: '1' repository: @@ -16180,7 +16199,7 @@ paths: application/json: schema: type: array - items: &146 + items: &149 title: Organization Simple description: A GitHub organization. type: object @@ -16252,7 +16271,7 @@ paths: - avatar_url - description examples: - default: &621 + default: &631 value: - login: github id: 1 @@ -16277,6 +16296,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: + - &90 + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: &321 + type: object + properties: + days: + type: integer + description: The number of days artifacts and logs are retained + maximum_allowed_days: + type: integer + description: The maximum number of days that can be configured + required: + - days + - maximum_allowed_days + examples: + response: + summary: Example response + value: + days: 90 + maximum_allowed_days: 365 + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set artifact and log retention settings for an organization + description: |- + Sets artifact and log retention settings for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/set-artifact-and-log-retention-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization + parameters: + - *90 + requestBody: + required: true + content: + application/json: + schema: &322 + type: object + properties: + days: + type: integer + description: The number of days to retain artifacts and logs + required: + - days + examples: + application/json: + value: + days: 100 + responses: + '204': + description: No content + '403': *27 + '404': *6 + '409': *45 + '422': *15 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/organizations/{org}/actions/permissions/fork-pr-contributor-approval": + get: + summary: Get fork PR contributor approval permissions for an organization + description: |- + Gets the fork PR contributor approval policy for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/get-fork-pr-contributor-approval-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization + parameters: + - *90 + responses: + '200': + description: Response + content: + application/json: + schema: &91 + type: object + properties: + approval_policy: + type: string + enum: + - first_time_contributors_new_to_github + - first_time_contributors + - all_external_contributors + description: The policy that controls when fork PR workflows require + approval from a maintainer. + required: + - approval_policy + examples: + default: &323 + value: + approval_policy: first_time_contributors + '404': *6 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set fork PR contributor approval permissions for an organization + description: |- + Sets the fork PR contributor approval policy for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/set-fork-pr-contributor-approval-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization + parameters: + - *90 + responses: + '204': + description: Response + '404': *6 + '422': *15 + requestBody: + required: true + content: + application/json: + schema: *91 + examples: + default: + summary: Set approval policy to first time contributors + value: + approval_policy: first_time_contributors + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/organizations/{org}/actions/permissions/fork-pr-workflows-private-repos": + get: + summary: Get private repo fork PR workflow settings for an organization + description: Gets the settings for whether workflows from fork pull requests + can run on private repositories in an organization. + operationId: actions/get-private-repo-fork-pr-workflows-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization + parameters: + - *90 + responses: + '200': + description: Response + content: + application/json: + schema: &324 + type: object + required: + - run_workflows_from_fork_pull_requests + - send_write_tokens_to_workflows + - send_secrets_and_variables + - require_approval_for_fork_pr_workflows + properties: + run_workflows_from_fork_pull_requests: + type: boolean + description: Whether workflows triggered by pull requests from + forks are allowed to run on private repositories. + send_write_tokens_to_workflows: + type: boolean + description: Whether GitHub Actions can create pull requests or + submit approving pull request reviews from a workflow triggered + by a fork pull request. + send_secrets_and_variables: + type: boolean + description: Whether to make secrets and variables available to + workflows triggered by pull requests from forks. + require_approval_for_fork_pr_workflows: + type: boolean + description: Whether workflows triggered by pull requests from + forks require approval from a repository administrator to run. + examples: + default: &92 + value: + run_workflows_from_fork_pull_requests: true + send_write_tokens_to_workflows: false + send_secrets_and_variables: false + require_approval_for_fork_pr_workflows: true + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set private repo fork PR workflow settings for an organization + description: Sets the settings for whether workflows from fork pull requests + can run on private repositories in an organization. + operationId: actions/set-private-repo-fork-pr-workflows-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization + parameters: + - *90 + requestBody: + required: true + content: + application/json: + schema: &325 + type: object + required: + - run_workflows_from_fork_pull_requests + properties: + run_workflows_from_fork_pull_requests: + type: boolean + description: Whether workflows triggered by pull requests from forks + are allowed to run on private repositories. + send_write_tokens_to_workflows: + type: boolean + description: Whether GitHub Actions can create pull requests or + submit approving pull request reviews from a workflow triggered + by a fork pull request. + send_secrets_and_variables: + type: boolean + description: Whether to make secrets and variables available to + workflows triggered by pull requests from forks. + require_approval_for_fork_pr_workflows: + type: boolean + description: Whether workflows triggered by pull requests from forks + require approval from a repository administrator to run. + examples: + default: *92 + responses: + '204': + description: Empty response for successful settings update + '403': + description: Forbidden - Fork PR workflow settings for private repositories + are managed by the enterprise owner + content: + application/json: + schema: *3 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/organizations/{org}/actions/permissions/self-hosted-runners": + get: + summary: Get self-hosted runners settings for an organization + description: |- + Gets the settings for self-hosted runners for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/get-self-hosted-runners-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization + parameters: + - *90 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - enabled_repositories + properties: + enabled_repositories: + type: string + description: The policy that controls whether self-hosted runners + can be used by repositories in the organization + enum: + - all + - selected + - none + selected_repositories_url: + type: string + description: The URL to the endpoint for managing selected repositories + for self-hosted runners in the organization + examples: + response: + summary: Example response + value: + enabled_repositories: selected + selected_repositories_url: http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set self-hosted runners settings for an organization + description: |- + Sets the settings for self-hosted runners for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/set-self-hosted-runners-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization + parameters: + - *90 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - enabled_repositories + properties: + enabled_repositories: + type: string + description: The policy that controls whether self-hosted runners + can be used in the organization + enum: + - all + - selected + - none + examples: + application/json: + value: + enabled_repositories: all + responses: + '204': + description: No content + '403': *27 + '404': *6 + '409': *45 + '422': *15 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/organizations/{org}/actions/permissions/self-hosted-runners/repositories": + get: + summary: List repositories allowed to use self-hosted runners in an organization + description: |- + Lists repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/list-selected-repositories-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - *90 + - *17 + - *19 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + total_count: + type: integer + repositories: + type: array + items: *59 + examples: + default: &109 + value: + total_count: 1 + repositories: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + '403': *27 + '404': *6 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set repositories allowed to use self-hosted runners in an organization + description: |- + Sets repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/set-selected-repositories-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - *90 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - selected_repository_ids + properties: + selected_repository_ids: + type: array + items: + type: integer + description: IDs of repositories that can use repository-level self-hosted + runners + examples: + application/json: + value: + selected_repository_ids: + - 1 + - 2 + - 3 + responses: + '204': + description: No content + '403': *27 + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/organizations/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}": + put: + summary: Add a repository to the list of repositories allowed to use self-hosted + runners in an organization + description: |- + Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/enable-selected-repository-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - *90 + - &93 + name: repository_id + description: The unique identifier of the repository. + in: path + required: true + schema: + type: integer + responses: + '204': + description: No content + '403': *27 + '404': *6 + '409': *45 + '422': *15 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + delete: + summary: Remove a repository from the list of repositories allowed to use self-hosted + runners in an organization + description: |- + Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/disable-selected-repository-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - *90 + - *93 + responses: + '204': + description: No content + '403': *27 + '404': *6 + '409': *45 + '422': *15 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions "/organizations/{org}/dependabot/repository-access": get: summary: Lists the repositories Dependabot can access in an organization @@ -16292,13 +16948,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: - - &90 - name: org - description: The organization name. The name is not case sensitive. - in: path - required: true - schema: - type: string + - *90 - name: page in: query description: The page number of results to fetch. @@ -16564,7 +17214,7 @@ paths: url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization parameters: - *90 - - &647 + - &657 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, @@ -16573,7 +17223,7 @@ paths: required: false schema: type: integer - - &648 + - &658 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 @@ -16582,7 +17232,7 @@ paths: required: false schema: type: integer - - &649 + - &659 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 @@ -16591,7 +17241,7 @@ paths: required: false schema: type: integer - - &650 + - &660 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 @@ -16674,7 +17324,7 @@ paths: repositoryName: github/example '400': *14 '403': *27 - '500': *91 + '500': *94 '503': *62 x-github: githubCloudOnly: false @@ -16707,7 +17357,7 @@ paths: description: Response content: application/json: - schema: &92 + schema: &95 title: Organization Full description: Organization Full type: object @@ -17102,7 +17752,7 @@ paths: - updated_at - archived_at examples: - default-response: &93 + default-response: &96 value: login: github id: 1 @@ -17419,17 +18069,17 @@ paths: description: Response content: application/json: - schema: *92 + schema: *95 examples: - default: *93 + default: *96 '422': description: Validation failed content: application/json: schema: oneOf: - - *94 - - *95 + - *97 + - *98 '409': *45 x-github: githubCloudOnly: false @@ -17543,7 +18193,7 @@ paths: type: integer repository_cache_usages: type: array - items: &306 + items: &311 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -17619,7 +18269,7 @@ paths: type: integer runners: type: array - items: &96 + items: &99 title: GitHub-hosted hosted runner description: A Github-hosted hosted runner. type: object @@ -17676,7 +18326,7 @@ paths: - size_gb - display_name - source - machine_size_details: &99 + machine_size_details: &102 title: Github-owned VM details. description: Provides details of a particular machine spec. type: object @@ -17781,7 +18431,7 @@ paths: - public_ip_enabled - platform examples: - default: &115 + default: &118 value: total_count: 2 runners: @@ -17908,9 +18558,9 @@ paths: description: Response content: application/json: - schema: *96 + schema: *99 examples: - default: &100 + default: &103 value: id: 5 name: My hosted ubuntu runner @@ -17965,7 +18615,7 @@ paths: type: integer images: type: array - items: &97 + items: &100 title: GitHub-hosted runner image details. description: Provides details of a hosted runner image type: object @@ -18005,7 +18655,7 @@ paths: - display_name - source examples: - default: &98 + default: &101 value: id: ubuntu-20.04 platform: linux-x64 @@ -18045,9 +18695,9 @@ paths: type: integer images: type: array - items: *97 + items: *100 examples: - default: *98 + default: *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18135,7 +18785,7 @@ paths: type: integer machine_specs: type: array - items: *99 + items: *102 examples: default: value: @@ -18205,7 +18855,7 @@ paths: url: https://docs.github.com/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization parameters: - *90 - - &101 + - &104 name: hosted_runner_id description: Unique identifier of the GitHub-hosted runner. in: path @@ -18217,9 +18867,9 @@ paths: description: Response content: application/json: - schema: *96 + schema: *99 examples: - default: *100 + default: *103 headers: Link: *57 x-github: @@ -18240,7 +18890,7 @@ paths: url: https://docs.github.com/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization parameters: - *90 - - *101 + - *104 requestBody: required: true content: @@ -18278,9 +18928,9 @@ paths: description: Response content: application/json: - schema: *96 + schema: *99 examples: - default: *100 + default: *103 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -18297,15 +18947,15 @@ paths: url: https://docs.github.com/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization parameters: - *90 - - *101 + - *104 responses: '202': description: Response content: application/json: - schema: *96 + schema: *99 examples: - default: *100 + default: *103 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -18331,7 +18981,7 @@ paths: description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &102 + schema: &105 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -18345,7 +18995,7 @@ paths: required: - include_claim_keys examples: - default: &103 + default: &106 value: include_claim_keys: - repo @@ -18372,15 +19022,15 @@ paths: required: true content: application/json: - schema: *102 + schema: *105 examples: - default: *103 + default: *106 responses: '201': description: Empty response content: application/json: - schema: &125 + schema: &128 title: Empty Object description: An object without any properties. type: object @@ -18419,7 +19069,7 @@ paths: schema: type: object properties: - enabled_repositories: &104 + enabled_repositories: &107 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -18432,7 +19082,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: &105 + allowed_actions: &108 type: string description: The permissions policy that controls the actions and reusable workflows that are allowed to run. @@ -18440,7 +19090,7 @@ paths: - all - local_only - selected - selected_actions_url: &312 + selected_actions_url: &317 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` @@ -18482,8 +19132,8 @@ paths: schema: type: object properties: - enabled_repositories: *104 - allowed_actions: *105 + enabled_repositories: *107 + allowed_actions: *108 required: - enabled_repositories examples: @@ -18530,127 +19180,7 @@ paths: type: array items: *59 examples: - default: &615 - 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: *109 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -18715,13 +19245,7 @@ paths: url: https://docs.github.com/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization parameters: - *90 - - &106 - name: repository_id - description: The unique identifier of the repository. - in: path - required: true - schema: - type: integer + - *93 responses: '204': description: Response @@ -18744,7 +19268,7 @@ paths: url: https://docs.github.com/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization parameters: - *90 - - *106 + - *93 responses: '204': description: Response @@ -18773,7 +19297,7 @@ paths: description: Response content: application/json: - schema: &107 + schema: &110 type: object properties: github_owned_allowed: @@ -18795,7 +19319,7 @@ paths: items: type: string examples: - default: &108 + default: &111 value: github_owned_allowed: true verified_allowed: false @@ -18828,9 +19352,9 @@ paths: required: false content: application/json: - schema: *107 + schema: *110 examples: - selected_actions: *108 + selected_actions: *111 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -18858,17 +19382,17 @@ paths: description: Response content: application/json: - schema: &316 + schema: &326 type: object properties: - default_workflow_permissions: &109 + default_workflow_permissions: &112 type: string description: The default workflow permissions granted to the GITHUB_TOKEN when running workflows. enum: - read - write - can_approve_pull_request_reviews: &110 + can_approve_pull_request_reviews: &113 type: boolean description: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. @@ -18876,7 +19400,7 @@ paths: - default_workflow_permissions - can_approve_pull_request_reviews examples: - default: &111 + default: &114 summary: Give read-only permission, and allow approving PRs. value: default_workflow_permissions: read @@ -18909,13 +19433,13 @@ paths: required: false content: application/json: - schema: &317 + schema: &327 type: object properties: - default_workflow_permissions: *109 - can_approve_pull_request_reviews: *110 + default_workflow_permissions: *112 + can_approve_pull_request_reviews: *113 examples: - default: *111 + default: *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18960,7 +19484,7 @@ paths: type: number runner_groups: type: array - items: &112 + items: &115 type: object properties: id: @@ -19150,9 +19674,9 @@ paths: description: Response content: application/json: - schema: *112 + schema: *115 examples: - default: &114 + default: &117 value: id: 2 name: octo-runner-group @@ -19188,7 +19712,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization parameters: - *90 - - &113 + - &116 name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path @@ -19200,7 +19724,7 @@ paths: description: Response content: application/json: - schema: *112 + schema: *115 examples: default: value: @@ -19237,7 +19761,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization parameters: - *90 - - *113 + - *116 requestBody: required: true content: @@ -19293,9 +19817,9 @@ paths: description: Response content: application/json: - schema: *112 + schema: *115 examples: - default: *114 + default: *117 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -19315,7 +19839,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization parameters: - *90 - - *113 + - *116 responses: '204': description: Response @@ -19339,7 +19863,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization parameters: - *90 - - *113 + - *116 - *17 - *19 responses: @@ -19357,9 +19881,9 @@ paths: type: number runners: type: array - items: *96 + items: *99 examples: - default: *115 + default: *118 headers: Link: *57 x-github: @@ -19382,7 +19906,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - *90 - - *113 + - *116 - *19 - *17 responses: @@ -19400,9 +19924,9 @@ paths: type: number repositories: type: array - items: *116 + items: *119 examples: - default: &607 + default: &618 value: total_count: 1 repositories: @@ -19655,7 +20179,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization parameters: - *90 - - *113 + - *116 requestBody: required: true content: @@ -19700,8 +20224,8 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - *90 - - *113 - - *106 + - *116 + - *93 responses: '204': description: Response @@ -19724,8 +20248,8 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - *90 - - *113 - - *106 + - *116 + - *93 responses: '204': description: Response @@ -19749,7 +20273,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization parameters: - *90 - - *113 + - *116 - *17 - *19 responses: @@ -19767,7 +20291,7 @@ paths: type: number runners: type: array - items: &118 + items: &121 title: Self hosted runners description: A self hosted runner type: object @@ -19801,7 +20325,7 @@ paths: type: boolean labels: type: array - items: &121 + items: &124 title: Self hosted runner label description: A label for a self hosted runner type: object @@ -19831,7 +20355,7 @@ paths: - busy - labels examples: - default: &119 + default: &122 value: total_count: 2 runners: @@ -19891,7 +20415,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization parameters: - *90 - - *113 + - *116 requestBody: required: true content: @@ -19936,8 +20460,8 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization parameters: - *90 - - *113 - - &117 + - *116 + - &120 name: runner_id description: Unique identifier of the self-hosted runner. in: path @@ -19966,8 +20490,8 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization parameters: - *90 - - *113 - - *117 + - *116 + - *120 responses: '204': description: Response @@ -20015,9 +20539,9 @@ paths: type: integer runners: type: array - items: *118 + items: *121 examples: - default: *119 + default: *122 headers: Link: *57 x-github: @@ -20049,7 +20573,7 @@ paths: application/json: schema: type: array - items: &318 + items: &328 title: Runner Application description: Runner Application type: object @@ -20074,7 +20598,7 @@ paths: - download_url - filename examples: - default: &319 + default: &329 value: - os: osx architecture: x64 @@ -20160,7 +20684,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &320 + '201': &330 description: Response content: application/json: @@ -20170,7 +20694,7 @@ paths: - runner - encoded_jit_config properties: - runner: *118 + runner: *121 encoded_jit_config: type: string description: The base64 encoded runner configuration. @@ -20233,7 +20757,7 @@ paths: description: Response content: application/json: - schema: &120 + schema: &123 title: Authentication Token description: Authentication Token type: object @@ -20275,7 +20799,7 @@ paths: - token - expires_at examples: - default: &321 + default: &331 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -20312,9 +20836,9 @@ paths: description: Response content: application/json: - schema: *120 + schema: *123 examples: - default: &322 + default: &332 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -20340,15 +20864,15 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization parameters: - *90 - - *117 + - *120 responses: '200': description: Response content: application/json: - schema: *118 + schema: *121 examples: - default: &323 + default: &333 value: id: 23 name: MBP @@ -20390,7 +20914,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization parameters: - *90 - - *117 + - *120 responses: '204': description: Response @@ -20417,9 +20941,9 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization parameters: - *90 - - *117 + - *120 responses: - '200': &122 + '200': &125 description: Response content: application/json: @@ -20433,7 +20957,7 @@ paths: type: integer labels: type: array - items: *121 + items: *124 examples: default: value: @@ -20473,7 +20997,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization parameters: - *90 - - *117 + - *120 requestBody: required: true content: @@ -20497,7 +21021,7 @@ paths: - gpu - accelerated responses: - '200': *122 + '200': *125 '404': *6 '422': *7 x-github: @@ -20522,7 +21046,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization parameters: - *90 - - *117 + - *120 requestBody: required: true content: @@ -20547,7 +21071,7 @@ paths: - gpu - accelerated responses: - '200': *122 + '200': *125 '404': *6 '422': *7 x-github: @@ -20572,9 +21096,9 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization parameters: - *90 - - *117 + - *120 responses: - '200': &324 + '200': &334 description: Response content: application/json: @@ -20588,7 +21112,7 @@ paths: type: integer labels: type: array - items: *121 + items: *124 examples: default: value: @@ -20630,8 +21154,8 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization parameters: - *90 - - *117 - - &325 + - *120 + - &335 name: name description: The name of a self-hosted runner's custom label. in: path @@ -20639,7 +21163,7 @@ paths: schema: type: string responses: - '200': *122 + '200': *125 '404': *6 '422': *7 x-github: @@ -20682,7 +21206,7 @@ paths: type: integer secrets: type: array - items: &123 + items: &126 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -20763,7 +21287,7 @@ paths: description: Response content: application/json: - schema: &337 + schema: &347 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -20798,7 +21322,7 @@ paths: - key_id - key examples: - default: &338 + default: &348 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -20824,7 +21348,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#get-an-organization-secret parameters: - *90 - - &124 + - &127 name: secret_name description: The name of the secret. in: path @@ -20836,7 +21360,7 @@ paths: description: Response content: application/json: - schema: *123 + schema: *126 examples: default: value: @@ -20867,7 +21391,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret parameters: - *90 - - *124 + - *127 requestBody: required: true content: @@ -20924,7 +21448,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *125 + schema: *128 examples: default: value: @@ -20951,7 +21475,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#delete-an-organization-secret parameters: - *90 - - *124 + - *127 responses: '204': description: Response @@ -20978,7 +21502,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - *90 - - *124 + - *127 - *19 - *17 responses: @@ -20996,9 +21520,9 @@ paths: type: integer repositories: type: array - items: *116 + items: *119 examples: - default: &128 + default: &131 value: total_count: 1 repositories: @@ -21091,7 +21615,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - *90 - - *124 + - *127 requestBody: required: true content: @@ -21144,7 +21668,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - *90 - - *124 + - *127 - name: repository_id in: path required: true @@ -21178,7 +21702,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - *90 - - *124 + - *127 - name: repository_id in: path required: true @@ -21211,7 +21735,7 @@ paths: url: https://docs.github.com/rest/actions/variables#list-organization-variables parameters: - *90 - - &311 + - &316 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)." @@ -21235,7 +21759,7 @@ paths: type: integer variables: type: array - items: &126 + items: &129 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -21373,7 +21897,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *125 + schema: *128 examples: default: value: @@ -21399,7 +21923,7 @@ paths: url: https://docs.github.com/rest/actions/variables#get-an-organization-variable parameters: - *90 - - &127 + - &130 name: name description: The name of the variable. in: path @@ -21411,7 +21935,7 @@ paths: description: Response content: application/json: - schema: *126 + schema: *129 examples: default: value: @@ -21442,7 +21966,7 @@ paths: url: https://docs.github.com/rest/actions/variables#update-an-organization-variable parameters: - *90 - - *127 + - *130 requestBody: required: true content: @@ -21505,7 +22029,7 @@ paths: url: https://docs.github.com/rest/actions/variables#delete-an-organization-variable parameters: - *90 - - *127 + - *130 responses: '204': description: Response @@ -21532,7 +22056,7 @@ paths: url: https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - *90 - - *127 + - *130 - *19 - *17 responses: @@ -21550,9 +22074,9 @@ paths: type: integer repositories: type: array - items: *116 + items: *119 examples: - default: *128 + default: *131 '409': description: Response when the visibility of the variable is not set to `selected` @@ -21579,7 +22103,7 @@ paths: url: https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - *90 - - *127 + - *130 requestBody: required: true content: @@ -21629,7 +22153,7 @@ paths: url: https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - *90 - - *127 + - *130 - name: repository_id in: path required: true @@ -21664,7 +22188,7 @@ paths: url: https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - *90 - - *127 + - *130 - name: repository_id in: path required: true @@ -21723,12 +22247,12 @@ paths: required: - subject_digests examples: - default: &636 + default: &646 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &637 + withPredicateType: &647 value: subject_digests: - sha256:abc123 @@ -21787,7 +22311,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &638 + default: &648 value: attestations_subject_digests: - sha256:abc: @@ -22081,7 +22605,7 @@ paths: bundle_url: type: string examples: - default: &351 + default: &361 value: attestations: - bundle: @@ -22200,7 +22724,7 @@ paths: type: array items: *4 examples: - default: &191 + default: &194 value: - login: octocat id: 1 @@ -22239,7 +22763,7 @@ paths: url: https://docs.github.com/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization parameters: - *90 - - &129 + - &132 name: username description: The handle for the GitHub user account. in: path @@ -22271,7 +22795,7 @@ paths: url: https://docs.github.com/rest/orgs/blocking#block-a-user-from-an-organization parameters: - *90 - - *129 + - *132 responses: '204': description: Response @@ -22292,7 +22816,7 @@ paths: url: https://docs.github.com/rest/orgs/blocking#unblock-a-user-from-an-organization parameters: - *90 - - *129 + - *132 responses: '204': description: Response @@ -22325,7 +22849,7 @@ paths: description: If specified, only campaigns with this state will be returned. in: query required: false - schema: &130 + schema: &133 title: Campaign state description: Indicates whether a campaign is open or closed type: string @@ -22351,7 +22875,7 @@ paths: application/json: schema: type: array - items: &131 + items: &134 title: Campaign summary description: The campaign metadata and alert stats. type: object @@ -22382,7 +22906,7 @@ paths: team_managers: description: The campaign team managers type: array - items: &147 + items: &150 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -22441,7 +22965,7 @@ paths: parent: anyOf: - type: 'null' - - &203 + - &206 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. @@ -22557,7 +23081,7 @@ paths: - string - 'null' format: date-time - state: *130 + state: *133 contact_link: description: The contact link of the campaign. type: @@ -22774,9 +23298,9 @@ paths: description: Response content: application/json: - schema: *131 + schema: *134 examples: - default: &132 + default: &135 value: number: 3 created_at: '2024-02-14T12:29:18Z' @@ -22859,9 +23383,9 @@ paths: description: Response content: application/json: - schema: *131 + schema: *134 examples: - default: *132 + default: *135 '404': *6 '422': description: Unprocessable Entity @@ -22939,7 +23463,7 @@ paths: - string - 'null' format: uri - state: *130 + state: *133 examples: default: value: @@ -22949,9 +23473,9 @@ paths: description: Response content: application/json: - schema: *131 + schema: *134 examples: - default: *132 + default: *135 '400': description: Bad Request content: @@ -23018,17 +23542,17 @@ paths: url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - *90 - - &376 + - &386 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: &135 + schema: &138 type: string description: The name of the tool used to generate the code scanning analysis. - - &377 + - &387 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 @@ -23036,7 +23560,7 @@ paths: or `tool_name`, but not both. in: query required: false - schema: &136 + schema: &139 type: - string - 'null' @@ -23052,7 +23576,7 @@ paths: be returned. in: query required: false - schema: &379 + schema: &389 type: string description: State of a code scanning alert. enum: @@ -23075,7 +23599,7 @@ paths: be returned. in: query required: false - schema: &380 + schema: &390 type: string description: Severity of a code scanning alert. enum: @@ -23101,13 +23625,13 @@ paths: updated_at: *54 url: *55 html_url: *56 - instances_url: &381 + instances_url: &391 type: string description: The REST API URL for fetching the list of instances for an alert. format: uri readOnly: true - state: &137 + state: &140 type: - string - 'null' @@ -23117,13 +23641,13 @@ paths: - dismissed - fixed - - fixed_at: *133 + fixed_at: *136 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *134 - dismissed_reason: &382 + dismissed_at: *137 + dismissed_reason: &392 type: - string - 'null' @@ -23134,14 +23658,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &383 + dismissed_comment: &393 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &384 + rule: &394 type: object properties: id: @@ -23202,26 +23726,26 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: &385 + tool: &395 type: object properties: - name: *135 + name: *138 version: type: - string - 'null' description: The version of the tool used to generate the code scanning analysis. - guid: *136 - most_recent_instance: &386 + guid: *139 + most_recent_instance: &396 type: object properties: - ref: &378 + ref: &388 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &396 + analysis_key: &406 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -23232,13 +23756,13 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &397 + category: &407 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: *137 + state: *140 commit_sha: type: string message: @@ -23741,7 +24265,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: *138 + code_scanning_options: *141 code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -23884,7 +24408,7 @@ paths: application/json: schema: *41 examples: - default: *139 + default: *142 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23912,9 +24436,9 @@ paths: description: Response content: application/json: - schema: *140 + schema: *143 examples: - default: *141 + default: *144 '304': *35 '403': *27 '404': *6 @@ -23966,7 +24490,7 @@ paths: - 32 - 91 responses: - '204': *142 + '204': *145 '400': *14 '403': *27 '404': *6 @@ -24001,7 +24525,7 @@ paths: application/json: schema: *41 examples: - default: *139 + default: *142 '304': *35 '403': *27 '404': *6 @@ -24285,7 +24809,7 @@ paths: - *90 - *43 responses: - '204': *142 + '204': *145 '400': *14 '403': *27 '404': *6 @@ -24423,7 +24947,7 @@ paths: default: value: default_for_new_repos: all - configuration: *139 + configuration: *142 '403': *27 '404': *6 x-github: @@ -24476,13 +25000,13 @@ paths: application/json: schema: type: array - items: *143 + items: *146 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: *144 + repository: *147 '403': *27 '404': *6 x-github: @@ -24522,7 +25046,7 @@ paths: type: integer codespaces: type: array - items: &192 + items: &195 type: object title: Codespace description: A codespace. @@ -24553,11 +25077,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *116 + repository: *119 machine: anyOf: - type: 'null' - - &409 + - &419 type: object title: Codespace machine description: A description of the machine powering a codespace. @@ -24844,7 +25368,7 @@ paths: - pulls_url - recent_folders examples: - default: &193 + default: &196 value: total_count: 3 codespaces: @@ -25254,7 +25778,7 @@ paths: stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop recent_folders: [] '304': *35 - '500': *91 + '500': *94 '401': *23 '403': *27 '404': *6 @@ -25320,7 +25844,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *91 + '500': *94 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -25375,7 +25899,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *91 + '500': *94 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -25429,7 +25953,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *91 + '500': *94 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -25468,7 +25992,7 @@ paths: type: integer secrets: type: array - items: &145 + items: &148 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -25509,7 +26033,7 @@ paths: - updated_at - visibility examples: - default: &410 + default: &420 value: total_count: 2 secrets: @@ -25547,7 +26071,7 @@ paths: description: Response content: application/json: - schema: &411 + schema: &421 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -25582,7 +26106,7 @@ paths: - key_id - key examples: - default: &412 + default: &422 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -25606,15 +26130,15 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret parameters: - *90 - - *124 + - *127 responses: '200': description: Response content: application/json: - schema: *145 + schema: *148 examples: - default: &414 + default: &424 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -25642,7 +26166,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - *90 - - *124 + - *127 requestBody: required: true content: @@ -25697,7 +26221,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *125 + schema: *128 examples: default: value: @@ -25724,7 +26248,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - *90 - - *124 + - *127 responses: '204': description: Response @@ -25750,7 +26274,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - *90 - - *124 + - *127 - *19 - *17 responses: @@ -25768,9 +26292,9 @@ paths: type: integer repositories: type: array - items: *116 + items: *119 examples: - default: *128 + default: *131 '404': *6 x-github: githubCloudOnly: false @@ -25793,7 +26317,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - *90 - - *124 + - *127 requestBody: required: true content: @@ -25844,7 +26368,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - *90 - - *124 + - *127 - name: repository_id in: path required: true @@ -25878,7 +26402,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - *90 - - *124 + - *127 - name: repository_id in: path required: true @@ -26026,7 +26550,7 @@ paths: cli: enabled public_code_suggestions: block plan_type: business - '500': *91 + '500': *94 '401': *23 '403': *27 '404': *6 @@ -26048,7 +26572,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: @@ -26081,7 +26605,7 @@ paths: currently being billed. seats: type: array - items: &195 + items: &198 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -26094,12 +26618,12 @@ paths: organization: anyOf: - type: 'null' - - *146 + - *149 assigning_team: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - *147 + - *150 - title: Enterprise Team description: Group of enterprise owners and/or members type: object @@ -26279,7 +26803,7 @@ paths: site_admin: false headers: Link: *57 - '500': *91 + '500': *94 '401': *23 '403': *27 '404': *6 @@ -26354,7 +26878,7 @@ paths: default: value: seats_created: 5 - '500': *91 + '500': *94 '401': *23 '403': *27 '404': *6 @@ -26432,7 +26956,7 @@ paths: default: value: seats_cancelled: 5 - '500': *91 + '500': *94 '401': *23 '403': *27 '404': *6 @@ -26511,7 +27035,7 @@ paths: default: value: seats_created: 5 - '500': *91 + '500': *94 '401': *23 '403': *27 '404': *6 @@ -26589,7 +27113,7 @@ paths: default: value: seats_cancelled: 5 - '500': *91 + '500': *94 '401': *23 '403': *27 '404': *6 @@ -26660,7 +27184,7 @@ paths: application/json: schema: type: array - items: &271 + items: &276 title: Copilot Usage Metrics description: Copilot usage metrics for a given day. type: object @@ -26975,7 +27499,7 @@ paths: - date additionalProperties: true examples: - default: &272 + default: &277 value: - date: '2024-06-24' total_active_users: 24 @@ -27074,10 +27598,10 @@ paths: custom_model_training_date: '2024-02-01' total_pr_summaries_created: 10 total_engaged_users: 4 - '500': *91 + '500': *94 '403': *27 '404': *6 - '422': &273 + '422': &278 description: Copilot Usage Merics API setting is disabled at the organization or enterprise level. content: @@ -27105,19 +27629,19 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - *90 - - *148 - - *149 - - *150 - *151 - *152 - *153 - *154 - *155 + - *156 + - *157 + - *158 - *46 - *38 - *39 - - *156 - - *157 + - *159 + - *160 - *17 responses: '200': @@ -27126,9 +27650,9 @@ paths: application/json: schema: type: array - items: *158 + items: *161 examples: - default: *159 + default: *162 '304': *35 '400': *14 '403': *27 @@ -27172,7 +27696,7 @@ paths: type: integer secrets: type: array - items: &160 + items: &163 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -27251,7 +27775,7 @@ paths: description: Response content: application/json: - schema: &437 + schema: &447 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -27270,7 +27794,7 @@ paths: - key_id - key examples: - default: &438 + default: &448 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -27294,13 +27818,13 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret parameters: - *90 - - *124 + - *127 responses: '200': description: Response content: application/json: - schema: *160 + schema: *163 examples: default: value: @@ -27329,7 +27853,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - *90 - - *124 + - *127 requestBody: required: true content: @@ -27384,7 +27908,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *125 + schema: *128 examples: default: value: @@ -27409,7 +27933,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret parameters: - *90 - - *124 + - *127 responses: '204': description: Response @@ -27434,7 +27958,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - *90 - - *124 + - *127 - *19 - *17 responses: @@ -27452,9 +27976,9 @@ paths: type: integer repositories: type: array - items: *116 + items: *119 examples: - default: *128 + default: *131 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27476,7 +28000,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - *90 - - *124 + - *127 requestBody: required: true content: @@ -27527,7 +28051,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - *90 - - *124 + - *127 - name: repository_id in: path required: true @@ -27559,7 +28083,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - *90 - - *124 + - *127 - name: repository_id in: path required: true @@ -27597,7 +28121,7 @@ paths: application/json: schema: type: array - items: &205 + items: &208 title: Package description: A software package type: object @@ -27650,7 +28174,7 @@ paths: repository: anyOf: - type: 'null' - - *116 + - *119 created_at: type: string format: date-time @@ -27668,7 +28192,7 @@ paths: - created_at - updated_at examples: - default: &206 + default: &209 value: - id: 197 name: hello_docker @@ -27835,7 +28359,7 @@ paths: application/json: schema: type: array - items: &183 + items: &186 title: Organization Invitation description: Organization Invitation type: object @@ -27889,7 +28413,7 @@ paths: - invitation_teams_url - node_id examples: - default: &184 + default: &187 value: - id: 1 login: monalisa @@ -27956,7 +28480,7 @@ paths: application/json: schema: type: array - items: &161 + items: &164 title: Org Hook description: Org Hook type: object @@ -28141,9 +28665,9 @@ paths: description: Response content: application/json: - schema: *161 + schema: *164 examples: - default: &162 + default: &165 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -28191,7 +28715,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook parameters: - *90 - - &163 + - &166 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. @@ -28204,9 +28728,9 @@ paths: description: Response content: application/json: - schema: *161 + schema: *164 examples: - default: *162 + default: *165 '404': *6 x-github: githubCloudOnly: false @@ -28234,7 +28758,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook parameters: - *90 - - *163 + - *166 requestBody: required: false content: @@ -28280,7 +28804,7 @@ paths: description: Response content: application/json: - schema: *161 + schema: *164 examples: default: value: @@ -28322,7 +28846,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook parameters: - *90 - - *163 + - *166 responses: '204': description: Response @@ -28350,7 +28874,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - *90 - - *163 + - *166 responses: '200': description: Response @@ -28381,7 +28905,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - *90 - - *163 + - *166 requestBody: required: false content: @@ -28432,9 +28956,9 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - *90 - - *163 + - *166 - *17 - - *164 + - *167 responses: '200': description: Response @@ -28442,9 +28966,9 @@ paths: application/json: schema: type: array - items: *165 + items: *168 examples: - default: *166 + default: *169 '400': *14 '422': *15 x-github: @@ -28470,16 +28994,16 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - *90 - - *163 + - *166 - *16 responses: '200': description: Response content: application/json: - schema: *167 + schema: *170 examples: - default: *168 + default: *171 '400': *14 '422': *15 x-github: @@ -28505,7 +29029,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - *90 - - *163 + - *166 - *16 responses: '202': *37 @@ -28535,7 +29059,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook parameters: - *90 - - *163 + - *166 responses: '204': description: Response @@ -28558,7 +29082,7 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor parameters: - *90 - - &173 + - &176 name: actor_type in: path description: The type of the actor @@ -28571,14 +29095,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &174 + - &177 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &169 + - &172 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`.' @@ -28586,7 +29110,7 @@ paths: required: true schema: type: string - - &170 + - &173 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) @@ -28681,12 +29205,12 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-subject-stats parameters: - *90 - - *169 - - *170 + - *172 + - *173 - *19 - *17 - *46 - - &179 + - &182 name: sort description: The property to sort the results by. in: query @@ -28766,14 +29290,14 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats parameters: - *90 - - *169 - - *170 + - *172 + - *173 responses: '200': description: Response content: application/json: - schema: &171 + schema: &174 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -28789,7 +29313,7 @@ paths: type: integer format: int64 examples: - default: &172 + default: &175 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -28810,23 +29334,23 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user parameters: - *90 - - &175 + - &178 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *169 - - *170 + - *172 + - *173 responses: '200': description: Response content: application/json: - schema: *171 + schema: *174 examples: - default: *172 + default: *175 x-github: enabledForGitHubApps: true category: orgs @@ -28845,18 +29369,18 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor parameters: - *90 - - *169 - - *170 + - *172 - *173 - - *174 + - *176 + - *177 responses: '200': description: Response content: application/json: - schema: *171 + schema: *174 examples: - default: *172 + default: *175 x-github: enabledForGitHubApps: true category: orgs @@ -28874,9 +29398,9 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-time-stats parameters: - *90 - - *169 - - *170 - - &176 + - *172 + - *173 + - &179 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -28889,7 +29413,7 @@ paths: description: Response content: application/json: - schema: &177 + schema: &180 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -28905,7 +29429,7 @@ paths: type: integer format: int64 examples: - default: &178 + default: &181 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -28942,18 +29466,18 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user parameters: - *90 - - *175 - - *169 - - *170 - - *176 + - *178 + - *172 + - *173 + - *179 responses: '200': description: Response content: application/json: - schema: *177 + schema: *180 examples: - default: *178 + default: *181 x-github: enabledForGitHubApps: true category: orgs @@ -28971,19 +29495,19 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor parameters: - *90 - - *173 - - *174 - - *169 - - *170 - *176 + - *177 + - *172 + - *173 + - *179 responses: '200': description: Response content: application/json: - schema: *177 + schema: *180 examples: - default: *178 + default: *181 x-github: enabledForGitHubApps: true category: orgs @@ -29001,13 +29525,13 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-user-stats parameters: - *90 - - *175 - - *169 - - *170 + - *178 + - *172 + - *173 - *19 - *17 - *46 - - *179 + - *182 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -29091,7 +29615,7 @@ paths: application/json: schema: *20 examples: - default: &476 + default: &486 value: id: 1 account: @@ -29257,12 +29781,12 @@ paths: application/json: schema: anyOf: - - &181 + - &184 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &180 + limit: &183 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -29290,7 +29814,7 @@ paths: properties: {} additionalProperties: false examples: - default: &182 + default: &185 value: limit: collaborators_only origin: organization @@ -29319,13 +29843,13 @@ paths: required: true content: application/json: - schema: &477 + schema: &487 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *180 + limit: *183 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -29350,9 +29874,9 @@ paths: description: Response content: application/json: - schema: *181 + schema: *184 examples: - default: *182 + default: *185 '422': *15 x-github: githubCloudOnly: false @@ -29428,9 +29952,9 @@ paths: application/json: schema: type: array - items: *183 + items: *186 examples: - default: *184 + default: *187 headers: Link: *57 '404': *6 @@ -29507,7 +30031,7 @@ paths: description: Response content: application/json: - schema: *183 + schema: *186 examples: default: value: @@ -29562,7 +30086,7 @@ paths: url: https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation parameters: - *90 - - &185 + - &188 name: invitation_id description: The unique identifier of the invitation. in: path @@ -29593,7 +30117,7 @@ paths: url: https://docs.github.com/rest/orgs/members#list-organization-invitation-teams parameters: - *90 - - *185 + - *188 - *17 - *19 responses: @@ -29603,9 +30127,9 @@ paths: application/json: schema: type: array - items: *147 + items: *150 examples: - default: &204 + default: &207 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -29648,7 +30172,7 @@ paths: application/json: schema: type: array - items: *186 + items: *189 examples: default: value: @@ -29736,9 +30260,9 @@ paths: description: Response content: application/json: - schema: *186 + schema: *189 examples: - default: &187 + default: &190 value: id: 410 node_id: IT_kwDNAd3NAZo @@ -29771,7 +30295,7 @@ paths: url: https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization parameters: - *90 - - &188 + - &191 name: issue_type_id description: The unique identifier of the issue type. in: path @@ -29827,9 +30351,9 @@ paths: description: Response content: application/json: - schema: *186 + schema: *189 examples: - default: *187 + default: *190 '404': *6 '422': *7 x-github: @@ -29854,7 +30378,7 @@ paths: url: https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization parameters: - *90 - - *188 + - *191 responses: '204': description: Response @@ -29917,7 +30441,7 @@ paths: - closed - all default: open - - *189 + - *192 - name: type description: Can be the name of an issue type. in: query @@ -29948,7 +30472,7 @@ paths: type: array items: *74 examples: - default: *190 + default: *193 headers: Link: *57 '404': *6 @@ -3{"code":"internal","msg":"git-diff-tree: context deadline exceeded","meta":{"cause":"*fmt.wrapError"}}